且构网

分享程序员开发的那些事...
且构网 - 分享程序员编程开发的那些事

从Python Docstrings自动生成GitHub Wiki文档

更新时间:2023-12-05 19:48:16

只需输出 docstring 到一个 .md 文件。



像这样:

  pydoc'example_lib> example_lib.md。 


The title says it all. What I imagine is to have docstrings for all of my modules, classes and functions and somehow nicely navigate the doc via github (wiki?). Also, the doc should be in sync with latest code meaning it should be updated/re-generated on push. Is that possible?

Just pipe the output of the docstring to a .md file.

Like this:

pydoc 'example_lib > example_lib.md .