Documenting CLI programs
Project description
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.
Install using pip:
$ pip install sphinxcontrib-autoprogramYou can find the 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.
Source Distribution
Built Distribution
File details
Details for the file sphinxcontrib-autoprogram-0.1.7.tar.gz.
File metadata
- Download URL: sphinxcontrib-autoprogram-0.1.7.tar.gz
- Upload date:
- Size: 18.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.1 CPython/3.9.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bc642e3f2817a7539f306e021697f72b225bea5ad23b30dc14a7b9d1408d1f1a |
|
| MD5 | 412aa62f9b9ec5d883e6ff31bd4a1e37 |
|
| BLAKE2b-256 | 23caffb97adb8938774c0746490d0e6fb1391bf04dc9b32902eff84e2a263d44 |
Provenance
File details
Details for the file sphinxcontrib_autoprogram-0.1.7-py2.py3-none-any.whl.
File metadata
- Download URL: sphinxcontrib_autoprogram-0.1.7-py2.py3-none-any.whl
- Upload date:
- Size: 8.7 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.1 CPython/3.9.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 746adb4214c3d2917af948499b3ed4b7b88b208a48c96368c0cff356474dba42 |
|
| MD5 | b81a1659e7e41e74309895e8d22372fa |
|
| BLAKE2b-256 | 1e8bd19bde42575942a4f97111c4eb28183776b619fd2f1e8df76a4d52f3caa7 |
