Usage
usage: pymdgen [-h] [--debug] [--section-level SECTION_LEVEL]
modules [modules ...]
Inspects given python modules and prints markdown
positional arguments:
modules
optional arguments:
-h, --help show this help message and exit
--debug display debug messages
--section-level SECTION_LEVEL
markdown section lavel
pymdgen pymdgen
Markdown extension
pymddgen also provides a markdown extension that allows you to easily insert code and command documentation into your generated docs.
Simply add the pymdgen
extension to the markdown_extensions
section in
your mkdocs.yml
config file.
Generate docs for a python module
{pymdgen:path.to.my.module}
Generate output for ls --help
{pymdgen-cmd:ls --help}