从Python Docstrings自动生成GitHub Wiki文档

时间:2015-04-15 20:39:54

标签: python github markdown wiki docstring

标题说明了一切。我想象的是为我的所有模块,类和函数提供docstrings,并通过github(wiki?)以某种方式很好地导航文档。此外,文档应与最新代码同步,这意味着它应该在推送时更新/重新生成。这可能吗?

1 个答案:

答案 0 :(得分:1)

只需将docstring的输出传输到.md文件即可。

像这样:

pydoc 'example_lib > example_lib.md .