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

Uploaded Source

File details

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

File metadata

File hashes

Hashes for sphinxcontrib-autoprogram-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e8217a2e902a781e86fee9cef89c2804e669cc0c43ec7afa42b7f9613a609c52
MD5 10e5c89b7118a6e0eca5a3fc2f5a9654
BLAKE2b-256 b77e40891bc1c4d3927d9701dfff9ef8f1e574060664d3e67414e61c92eb9db5

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