Automatically Generate GitHub Wiki Documentation from Python Docstrings

耗尽温柔 提交于 2019-12-05 18:50:12

问题


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?


回答1:


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

Like this:

pydoc 'example_lib > example_lib.md .


来源:https://stackoverflow.com/questions/29660467/automatically-generate-github-wiki-documentation-from-python-docstrings

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!