sphinxcontrib-autoprogram

automated documentation of CLI programs for Sphinx (Python 2)

Description

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.

In order to use it, add sphinxcontrib.autoprogram into extensions list of your Sphinx configuration file (conf.py)

This package contains the Python 2 version.

Upload more screenshots

Please help extend the collection of screenshots. Just make a screenshot and upload it here. You don't need to register or anything.

Upload a screenshot

Hint: upload an image here from your clipboard with Ctrl-V


Homepage

https://pythonhosted.org/sphinxcontrib-autoprogram/


Install this software package

If the package is available for the distribution you are currently using on your computer then install the software by clicking on…

Install sphinxcontrib-autoprogram