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.2.tar.gz
(8.4 kB
view hashes)
Built Distribution
Close
Hashes for pydoc_quarto-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c048cca46ff23908919fa9fc789f313b1dca3e684ee650689b2786da2c64f64 |
|
MD5 | 2f7d261135cafb98819350b890454a59 |
|
BLAKE2b-256 | b7576a90911eeef036016eb82b31de56e027cf097440740b4f1deba4e73da8e0 |