btd.sphinx.autoprogram 0.1.7.post1

Documenting CLI programs

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/