Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!


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.

Release History

This version
History Node


History Node


History Node


Download Files

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

File Name & Hash SHA256 Hash Help Version File Type Upload Date
(51.9 kB) Copy SHA256 Hash SHA256
py2.py3 Wheel Jul 8, 2015
(22.9 kB) Copy SHA256 Hash SHA256
Source Aug 18, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting