griffe2md
Output API docs to Markdown using Griffe.
Installation
pip install griffe2md
With uv:
uv tool install griffe2md
Usage
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 markdown.md
griffe2md can be configured in either pyproject.toml or a griffe2md.toml file. The latter can be placed in a .config or config directory in the project root.
griffe2md.toml file is structured as a simple key-value dictionary, e.g.:
docstring_style = "sphinx"
If you configure it in pyproject.toml, the configuration should go under the tool.griffe2md key:
[tool.griffe2md]
docstring_style = "sphinx"
See the documentation for reference.
Sponsors
And 4 more private sponsor(s).
1 maintainer
Metadata
1 maintainer
Release files for griffe2md 1.5.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| griffe2md-1.5.1.tar.gz | 50.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| griffe2md-1.5.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 87.5 kB
Release files / griffe2md-1.5.1.tar.gz
| Download URL | griffe2md-1.5.1.tar.gz |
|---|---|
| Size | 50.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6ccf7ed1db2955c70b88eabf404f4f6a2c632d50790157fc3d3b7d269017dffd
|
|
BLAKE2b-256 checksum How to use checksums |
fd28588e886370cb55d351895c86e5b9574293769a902b7f722d341f08d357d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
Release files / griffe2md-1.5.1-py3-none-any.whl
| Download URL | griffe2md-1.5.1-py3-none-any.whl |
|---|---|
| Size | 37.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
74ef2ed31926b241186f7c4c5f3f30725e4579468717d4c4f7f1565b41f40f8a
|
|
BLAKE2b-256 checksum How to use checksums |
98d3c45c4e97e10b8ec466d472a35f10a651080ddec636dc805599a305f5d4ac
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
