Documenting CLI programs
Project description
btd.sphinx.autoprogram
This contrib extension, sphinxcontrib.autoprogram, provides an automated way to document CLI programs. It scans argparse.ArgumentParser object, and then expands it into a set of .. program:: and .. option:: directives.
This is a patched version of sphinxcontrib.autoprogram written by Hong Minhee.
Note: Patched versions of internal packages from Sphinx are released as M.M.P.postN versions. So 2.3.1.post1 is the patched module version derived from Sphinx 2.3.1.
Added features and changes
- 0.1.7.post1
- Updated patched version to match upstream version 0.1.7.
- 0.1.6.post1
- New option label to add a label/anchor that can be referenced with :ref:
Install using pip:
$ pip install btd.sphinx.autoprogram
You can find the original documentation from the following URL:
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.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size btd.sphinx.autoprogram-0.1.7.post1-py2.py3-none-any.whl (21.5 kB) | File type Wheel | Python version py2.py3 | Upload date | Hashes View |
| Filename, size btd.sphinx.autoprogram-0.1.7.post1.tar.gz (20.7 kB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for btd.sphinx.autoprogram-0.1.7.post1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 45099175fff05d94c72a4e596e28e2a5f0c93a0236c1eba2283d3744b1ca7a7e |
|
| MD5 | 1bda3c7ad7aedae4a91b9fb0ab740e7e |
|
| BLAKE2-256 | b5a437131fe108641616fd197858ca55aaeb4a107b948b474905f7e63b3264c2 |
Close
Hashes for btd.sphinx.autoprogram-0.1.7.post1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 67f181bed2d5362a16dec90bfa009fa8d3a21c6006ea9dfbef1c6615a311dc43 |
|
| MD5 | c1b4411092bb88c9afa99449bdef250b |
|
| BLAKE2-256 | cce297215b66bdcc655da4e19cf1feceb69df056a6923c81ff5a161fa3250808 |