gist/Python/Creating_Documentation/pydoc_markdown.md

Notes on creating documentation

Use pydoc-markdown:

https://pypi.org/project/pydoc-markdown/

pydoc-markdown -p dryad2dataverse --render-toc > outputfile.md

Note the -p switch for loading a package instead of a single module (ie, -m)

Can be used with mkdocs to produce JustTheDocs format static pages:

https://www.mkdocs.org/