Generate minimal reference API docs from a python library in the form of markdown files that can be rendered in Quarto.
Project description
pydoc-quarto
Install
pip install pydoc_quarto
Usage
!pydoc_quarto -h
usage: pydoc_quarto [-h] lib dest_dir
Generate Markdown API docs
positional arguments:
lib the name of the python library
dest_dir the destination directory the markdown files will be rendered into
options:
-h, --help show this help message and exit
Example
This will generate markdown files for the requests
library:
!pydoc_quarto requests _test_dir/
!ls _test_dir/
adapters.md certs.md exceptions.md models.md status_codes.md
api.md compat.md help.md packages.md structures.md
auth.md cookies.md hooks.md sessions.md utils.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
pydoc_quarto-0.0.1.tar.gz
(8.4 kB
view hashes)
Built Distribution
Close
Hashes for pydoc_quarto-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce6c2a51e392156d6615a2a520f9f5da64e10149e67c9fe8a94ab153ff1e5954 |
|
MD5 | 0b0bd698b51d0e23b0ea79628a1d86cc |
|
BLAKE2b-256 | 44a1e573896462d2ee397ca36b74d008e2e6e6a20e2c077637810aecea0c865a |