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:
The executable scripts use the Python argparse module for argument parsing.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinxcontrib-argdoc-0.1.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a062b96bca3c1cb9b2c4cfeed09dd4d78d32ea8ddb2c38769df22671a2c78439 |
|
MD5 | cc0837696f6f264de602a4f8566be083 |
|
BLAKE2b-256 | 22a7e167af1c16d0640ac41a0d45d443307271c346ea9bccba1897809a74e87e |
Hashes for sphinxcontrib_argdoc-0.1.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 13485163bbaca777eb58fd53e2948531ffc4b71221b91644db889ab552724be7 |
|
MD5 | b14a7763a6cc1a13ba16843484f41ab3 |
|
BLAKE2b-256 | b89efad1332271473652d7702dfc89f76017cb6ef854581b3582c0ecdfe79f07 |