griffe2md

使用Griffe将API文档输出为Markdown格式。

安装

使用pip

pip install griffe2md

使用pipx

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

使用方法

只需使用包名或包文件夹的路径调用griffe2md

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

使用-o，--output选项将输出写入文件，而不是标准输出

griffe2md markdown -o markdown.md