Skip to main content


Project description


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 :automodule: documentation generated for the scripts by the Sphinx extension autodoc.

The only requirements are:

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

For more info, detailed instructions, and examples, see the sphinxcontrib-argdoc documentation.

Installation and use

sphinxcontrib-argdoc may be installed from PyPI using pip. Alternatively, you can clone the development version into your PYTHONPATH.

To use sphinxcontrib-argdoc, simply add ‘sphinxcontrib.argdoc’ to the list of extensions in your project’s Sphinx configuration file

# somewhere in
extensions = ['sphinxcontrib.argdoc',


Tests are written using nose, and may be found in the subpackage sphinxcontrib.argdoc.test. To run the tests, type from the terminal:

$ nosetests sphinxcontrib.argdoc.test


sphinxcontrib-argdoc is licensed under the BSD 3-Clause License.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-argdoc, version 0.1.3
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_argdoc-0.1.3-py2.py3-none-any.whl (51.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size sphinxcontrib-argdoc-0.1.3.tar.gz (22.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page