Output API docs to Markdown using Griffe.
Project description
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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
griffe2md-1.1.0.tar.gz
(34.2 kB
view details)
Built Distribution
griffe2md-1.1.0-py3-none-any.whl
(24.6 kB
view details)
File details
Details for the file griffe2md-1.1.0.tar.gz.
File metadata
- Download URL: griffe2md-1.1.0.tar.gz
- Upload date:
- Size: 34.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 930d8e058f44ee5a3111e3e94500ea3ce4e9c487ce291194c427856f796ad5e6 |
|
| MD5 | 0eeabc3c59feb414bfa977820cf12055 |
|
| BLAKE2b-256 | acab252d135c0a0f67bc0d38c1df022047ea102611b6e3df815445e135466859 |
File details
Details for the file griffe2md-1.1.0-py3-none-any.whl.
File metadata
- Download URL: griffe2md-1.1.0-py3-none-any.whl
- Upload date:
- Size: 24.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 11af820d6dfaa803a52994da9d0a52fdb1c60e1df1cafe287309378e6901b03f |
|
| MD5 | de5795314e33cd66ff405a654c505f06 |
|
| BLAKE2b-256 | 99d67098b7ecf543fe1ef9a13063b7f5adcbfc5c6f018285c7ddd2062aee83b2 |
