Skip to main content
Help us improve Python packaging – donate today!

Sphinx

Project Description

Introduction

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 conf.py:

# somewhere in conf.py
extensions = ['sphinxcontrib.argdoc',
              'another_extension',
              'some_other_extension'
             ]

Tests

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

License

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

Release history Release notifications

This version
History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxcontrib_argdoc-0.1.3-py2.py3-none-any.whl (51.9 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jul 8, 2015
sphinxcontrib-argdoc-0.1.3.tar.gz (22.9 kB) Copy SHA256 hash SHA256 Source None Aug 18, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page