zachriggle / autoprogram

Documenting CLI programs

Home Page:https://pypi.org/project/sphinxcontrib-autoprogram/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

sphinxcontrib.autoprogram --- Documenting CLI programs

This contrib extension, sphinxcontrib.autoprogram, provides an automated way to document CLI programs. It scans arparser.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://pythonhosted.org/sphinxcontrib-autoprogram/

About

Documenting CLI programs

https://pypi.org/project/sphinxcontrib-autoprogram/


Languages

Language:Python 100.0%