内容简介:标题说明了一切.我想象的是为我的所有模块,类和函数提供docstrings,并通过github(wiki?)以某种方式很好地导航文档.此外,文档应与最新代码同步,这意味着它应该在推送时更新/重新生成.那可能吗?翻译自:https://stackoverflow.com/questions/29660467/automatically-generate-github-wiki-documentation-from-python-docstrings
标题说明了一切.我想象的是为我的所有模块,类和函数提供docstrings,并通过github(wiki?)以某种方式很好地导航文档.此外,文档应与最新代码同步,这意味着它应该在推送时更新/重新生成.那可能吗?
只需将docstring的输出传递给.md文件即可.
像这样:
pydoc 'example_lib > example_lib.md .
翻译自:https://stackoverflow.com/questions/29660467/automatically-generate-github-wiki-documentation-from-python-docstrings
以上所述就是小编给大家介绍的《从Python Docstrings自动生成GitHub Wiki文档》,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对 码农网 的支持!
猜你喜欢:- 数据生成工具 ZenData 发布 2.0 版本,自动生成“互联网黑话”!
- 自动生成高效DNN,适用于边缘设备的生成合成工具FermiNets
- Simulink自动生成代码
- changelog 日志自动生成插件
- 深度有趣 | 23 歌词古诗自动生成
- 自定义Mybatis自动生成代码规则
本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。
REST in Practice
Jim Webber、Savas Parastatidis、Ian Robinson / O'Reilly Media / 2010-9-24 / USD 44.99
Why don't typical enterprise projects go as smoothly as projects you develop for the Web? Does the REST architectural style really present a viable alternative for building distributed systems and ent......一起来看看 《REST in Practice》 这本书的介绍吧!