A Python package for automatically generating documentation pages in markdown
mkgendocs
A Python package for automatically generating documentation pages in markdown for Python source files by parsing Google style docstring. The markdown output makes it ideal to combine with mkdocs.
Instead of executing the python code (using the inspect package to access signatures and docstrings), we extract the information directly from the source files by parsing them into Abstract Syntax Trees (AST) using the ast package.
The astor (AST observe/rewrite) package is also used to convert function or class signatures from AST nodes back into source code strings.
Installation
Install mkgendocs from PyPI
pip install mkgendocs
Usage
gendocs --config mkgendocs.yml
A sources directory is created with the documentation that was automatically generated.
Any examples in a “examples” directory are automatically copied