Skip to main content
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/

Metadata

Release files for btd.sphinx.autoprogram 0.1.7.post1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for btd.sphinx.autoprogram 0.1.7.post1
File Size Uploaded
btd.sphinx.autoprogram-0.1.7.post1.tar.gz 20.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for btd.sphinx.autoprogram 0.1.7.post1
File Interpreter ABI Platform
btd.sphinx.autoprogram-0.1.7.post1-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 42.2 kB

Release files / btd.sphinx.autoprogram-0.1.7.post1.tar.gz

Download URL btd.sphinx.autoprogram-0.1.7.post1.tar.gz
Size 20.7 kB
Tags Source
SHA-256 checksum
How to use checksums
67f181bed2d5362a16dec90bfa009fa8d3a21c6006ea9dfbef1c6615a311dc43
BLAKE2b-256 checksum
How to use checksums
cce297215b66bdcc655da4e19cf1feceb69df056a6923c81ff5a161fa3250808
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

Release files / btd.sphinx.autoprogram-0.1.7.post1-py2.py3-none-any.whl

Download URL btd.sphinx.autoprogram-0.1.7.post1-py2.py3-none-any.whl
Size 21.5 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
45099175fff05d94c72a4e596e28e2a5f0c93a0236c1eba2283d3744b1ca7a7e
BLAKE2b-256 checksum
How to use checksums
b5a437131fe108641616fd197858ca55aaeb4a107b948b474905f7e63b3264c2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page