sphinxcontrib.autoprogram

.. image:: https://badge.fury.io/py/sphinxcontrib-autoprogram.svg :target: https://pypi.org/project/sphinxcontrib-autoprogram/ :alt: Latest PyPI version

.. image:: https://readthedocs.org/projects/sphinxcontrib-autoprogram/badge/ :target: https://sphinxcontrib-autoprogram.readthedocs.io/ :alt: Documentation Status

.. image:: https://github.com/sphinx-contrib/autoprogram/workflows/Build%20and%20Test/badge.svg?branch=master :target: https://github.com/sphinx-contrib/autoprogram/actions :alt: 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:

.. code-block:: console

$ pip install sphinxcontrib-autoprogram

You can find the documentation from the following URL:

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