Skip to main content

Documenting CLI programs

Project description

Sourcecode on GitHub GitHub tag (latest SemVer incl. pre-release GitHub release (latest SemVer incl. including pre-releases GitHub release date Libraries.io status for latest release PyPI - Tag PyPI - Status PyPI - Python Version Dependent repos (via libraries.io)

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:

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

Download files

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

Files for btd.sphinx.autoprogram, version 0.1.7.post1
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

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page