Skip to main content

Documenting CLI programs

Project description

Latest PyPI version Documentation Status Build Status

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-autoprogram

You can find the documentation from the following URL:

https://sphinxcontrib-autoprogram.readthedocs.io/

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.9.tar.gz (18.8 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib_autoprogram-0.1.9-py2.py3-none-any.whl (8.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for sphinxcontrib-autoprogram-0.1.9.tar.gz
Algorithm Hash digest
SHA256 219655507fadca29b3062b5d86c37d94db48f03bde4b58d61526872bf72f57cc
MD5 9372d8fe1973789167bee7278561ba54
BLAKE2b-256 c85f044c87c306c9cbac68a4dccacb18ca0fdd4973096fdd92304ea069b11c59

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for sphinxcontrib_autoprogram-0.1.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 79a5282d7640337e4bf11f624970a43709f1b704c5c59a59756d45e824db5301
MD5 0f6e9b2cae2b29d38c72fc0851d269ca
BLAKE2b-256 134c5d9fb7caee7a765c2daf48cdf097c396eef3e1370290589f1b9e30266694

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