Output API docs to Markdown using Griffe.
Project description
griffe2md
Output API docs to Markdown using Griffe.
Installation
With pip:
pip install griffe2md
With pipx:
python3.8 -m pip install --user pipx
pipx 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
Release history Release notifications | RSS feed
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.0.2.tar.gz
(33.9 kB
view details)
Built Distribution
griffe2md-1.0.2-py3-none-any.whl
(25.1 kB
view details)
File details
Details for the file griffe2md-1.0.2.tar.gz.
File metadata
- Download URL: griffe2md-1.0.2.tar.gz
- Upload date:
- Size: 33.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 21979678fe2e48000ea9a971fee4eac137db41d1c85348373ac6e81ae573ee61 |
|
| MD5 | 07ae8869397c1b53fe55df52fa482e11 |
|
| BLAKE2b-256 | 1c92e9bc95429e7ad038fe5813e012e7bc226470e34c97f685b20a922e2ec813 |
File details
Details for the file griffe2md-1.0.2-py3-none-any.whl.
File metadata
- Download URL: griffe2md-1.0.2-py3-none-any.whl
- Upload date:
- Size: 25.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 03d78535def5ee95cc0140497b68a19f45c2d272f3a8090d19573c8af818f1dd |
|
| MD5 | cb3963e1fc0e75c7c9d3da391818d703 |
|
| BLAKE2b-256 | 383531fc1f6b3c8e1a31abe147911c51698d4087e809d7dd78c109f21d604a76 |
