Skip to content


ci documentation pypi version gitpod gitter

Output API docs to Markdown using Griffe.


With pip:

pip install griffe2md

With pipx:

python3.8 -m pip install --user pipx
pipx install griffe2md


Simply call griffe2md with a package name, or the path to a package folder:

griffe2md markdown
griffe2md path/to/my/src/package

Use the -o, --output option to write to a file instead of standard output:

griffe2md markdown -o