Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Automatically Generate GitHub Wiki Documentation from Python Docstrings

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?

like image 706
Giampaolo Rodolà Avatar asked Apr 15 '15 20:04

Giampaolo Rodolà


1 Answers

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

Like this:

pydoc example_lib > example_lib.md .
like image 195
Kevin Gray Avatar answered Oct 19 '22 20:10

Kevin Gray