从Python Docstrings自动生成GitHub Wiki文档

Gia*_*olà 9 python markdown wiki docstring github

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

小智 2

只需将生成的输出通过管道传输docstring.md文件即可。

像这样:

pydoc example_lib > example_lib.md .
Run Code Online (Sandbox Code Playgroud)