Sphinx extension to generate documentation for command-line scripts
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 Distributions
Built Distribution
Hashes for sphinxcontrib_argdoc-0.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7fdad637d7a5da551bbd55a24ff6e608a623854f95eceb2de578ae5ac78c1e4b |
|
MD5 | 5555b2490cfce1ffabb35aee06e3b9b6 |
|
BLAKE2b-256 | 9a9f487595def57530cf291adb89c2b9cff91bb78b7848d70076e907fac43242 |