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/
requests.adapters.qmd requests.cookies.qmd requests.packages.qmd
requests.api.qmd requests.exceptions.qmd requests.sessions.qmd
requests.auth.qmd requests.help.qmd requests.status_codes.qmd
requests.certs.qmd requests.hooks.qmd requests.structures.qmd
requests.compat.qmd requests.models.qmd requests.utils.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.3.tar.gz
(9.1 kB
view hashes)
Built Distribution
Close
Hashes for pydoc_quarto-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 386b1924285b1c9bf56e151fbc6826b297c15a8393dee8b092770d0c1d6ebc98 |
|
MD5 | 464a11c9db727bc471507ab4087ac382 |
|
BLAKE2b-256 | 839ab394b1f20d992ec1a9a85ab175d9d9f83cdf699bf1e0fa5db8fd8f458ec6 |