Skip to main content

Documenting CLI programs

Project description

This contrib extension, sphinxcontrib.autoprogram, provides an automated way to document CLI programs. It scans arparser.ArgumentParser object, and then expands it into a set of .. program:: and .. option:: directives.

You can find the documentation from the following URL:

https://pythonhosted.org/sphinxcontrib-autoprogram/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib-autoprogram-0.1.1.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib_autoprogram-0.1.1-py2.py3-none-any.whl (6.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sphinxcontrib-autoprogram-0.1.1.tar.gz.

File metadata

File hashes

Hashes for sphinxcontrib-autoprogram-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b6a7a935b66bf4f23dcb0ab7bff9be09e5ac52930fa00e64646ef2e0deb01942
MD5 5efdd7b7c67882a50eea6bbc40a96885
BLAKE2b-256 649ce79c73191f00161026385348e8077baa967159a2fdd4f41d0be3aebe1f86

See more details on using hashes here.

Provenance

File details

Details for the file sphinxcontrib_autoprogram-0.1.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for sphinxcontrib_autoprogram-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 55dd1de4a3b0c6284c38e13a561ed4a5fa85886d0ebf182dd08fdbbf9fad9712
MD5 922e77204c3a1d879b0bc7cbf5fd1075
BLAKE2b-256 dfa1607f42688ef17908cde01d1177cba0352902d74f41cb64256154dbd79cf4

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page