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
Project details
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.0.tar.gz
(16.2 kB
view hashes)
Built Distribution
griffe2md-1.0.0-py3-none-any.whl
(25.1 kB
view hashes)
Close
Hashes for griffe2md-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3d4ac46a79d8863acd23c59cba40d1a06db0fb295a569c837e2fc69e1db7251e |
|
MD5 | b079e9e54e52a8545b596e87b41b2373 |
|
BLAKE2b-256 | 45858140a71913890611860a4afd4757d00b8aa12c199a20a3619ac1f26a3a62 |