从Python Docstrings自动生成GitHub Wiki文档

栏目: Python · 发布时间: 6年前

内容简介：标题说明了一切.我想象的是为我的所有模块,类和函数提供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文档》，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对码农网的支持！

查看所有标签

猜你喜欢:

本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。

码农书籍

iOS应用逆向工程第2版

沙梓社、吴航 / 机械工业出版社 / 2015-4-1 / 79.00

你是否曾因应用上线的第一天即遭破解而无奈苦恼，想要加以防范，却又束手无策？你是否曾为某一应用深深折服，想要借鉴学习，却又无从下手？你是否已不满足于public API，想要进军Cydia开发，却又求学无门？你是否已产生“不识Apple真面目，只缘身在App Store中”的危机感，想要通过阅读来一窥这冰山一角外的整个北极，却又找不到合适的书？你是否已经因无法跨越开发......一起来看看《iOS应用逆向工程第2版》这本书的介绍吧!

码农工具