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 Quarto 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.qmd compat.qmd hooks.qmd status_codes.qmd
api.qmd cookies.qmd models.qmd structures.qmd
auth.qmd exceptions.qmd packages.qmd utils.qmd
certs.qmd help.qmd sessions.qmd
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.5.tar.gz
(9.2 kB
view hashes)
Built Distribution
Close
Hashes for pydoc_quarto-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5c5b0cbb646de26ab43a6c5989f42a515bca82de3f399945134dd6bb2aea422 |
|
MD5 | 4089f62e924d3bc230209709d8cb4a9c |
|
BLAKE2b-256 | 092d7a04e39a05d74abe10e850865ec620e0ee9d47c4b4fe9bc7d3a6f487e83f |