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.1.tar.gz
(34.2 kB
view details)
Built Distribution
griffe2md-1.0.1-py3-none-any.whl
(25.1 kB
view details)
File details
Details for the file griffe2md-1.0.1.tar.gz.
File metadata
- Download URL: griffe2md-1.0.1.tar.gz
- Upload date:
- Size: 34.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ffd772edbc2b552d7fae7b47aa203615baf946d21c0962cec686eb8f32101c0d |
|
| MD5 | f31debe3d6bf6b3e9e7522b0f4ae33f0 |
|
| BLAKE2b-256 | 02dd6bdaf2123b76671d492e0d8148044eb7744879f677e4b41f1b887af1bc1f |
File details
Details for the file griffe2md-1.0.1-py3-none-any.whl.
File metadata
- Download URL: griffe2md-1.0.1-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 | 61b4814b5c0c939aaefb372541077c07bc1366c74c658a7bc47824266227d5c2 |
|
| MD5 | 709bfe0a0b3d6a0a0150ea1f003b9818 |
|
| BLAKE2b-256 | 8524b1eaea48d603883af50b4f75d022e9c59148567861abe57f86e3a69207dd |
