Paebbels.sphinxcontrib.autoprogram

Documenting CLI programs


Keywords
python3, sphinx-doc, sphinx-extension
License
BSD-2-Clause
Install
pip install Paebbels.sphinxcontrib.autoprogram==0.1.6a1.post2

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/