Documenting CLI programs
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
- Updated patched version to match upstream version 0.1.7.
- 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:
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for btd.sphinx.autoprogram-0.1.7.post1.tar.gz
Hashes for btd.sphinx.autoprogram-0.1.7.post1-py2.py3-none-any.whl