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?
Kevin Gray
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