sphinxcontrib-autoprogram

Documenting CLI programs


Keywords
argparse, cli, sphinx-extension, sphinxcontrib
License
BSD-2-Clause
Install
pip install sphinxcontrib-autoprogram==0.1.9

Documentation

sphinxcontrib.autoprogram

Latest PyPI version Documentation Status Build Status

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.

Install using pip:

$ pip install sphinxcontrib-autoprogram

You can find the documentation from the following URL:

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