welcome to sphinxcontrib-argdoc


sphinxcontrib.argdoc is an extension for the Sphinx documentation engine.

It automatically generates tables describing command-line arguments for executable scripts written in Python, and inserts those tables into the scripts’ :automodule: documentation. The only requirements are:

  1. The exectuable scripts use the Python argparse module for argument parsing
  2. The rst stub files for the scripts include the :automodule: directive (which they will, by default, if you use sphinx-apidoc).

To start using sphinxcontrib.argdoc, see the Quickstart guide.

To view the source code, check out the sphinx-contrib repository on BitBucket.

Indices and tables