1 file was added to this release more than 14 days after its initial publication. Inspect the release files before installing.
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.
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-argdoc 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
File added late
1 file was uploaded more than 14 days after the first file in this release.
While project maintainers occasionally add legitimate files to an existing release, late additions can also indicate a security compromise.
We recommend inspecting the release files before installing.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxcontrib-argdoc-0.1.3.tar.gz | 22.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_argdoc-0.1.3-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 74.8 kB
Release files / sphinxcontrib-argdoc-0.1.3.tar.gz
File added late
This file was uploaded more than 14 days after the first file in this release.
While project maintainers occasionally add legitimate files to an existing release, late additions can also indicate a security compromise.
We recommend inspecting the release file before installing.
| Download URL | sphinxcontrib-argdoc-0.1.3.tar.gz |
|---|---|
| Size | 22.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a062b96bca3c1cb9b2c4cfeed09dd4d78d32ea8ddb2c38769df22671a2c78439
|
|
BLAKE2b-256 checksum How to use checksums |
22a7e167af1c16d0640ac41a0d45d443307271c346ea9bccba1897809a74e87e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / sphinxcontrib_argdoc-0.1.3-py2.py3-none-any.whl
| Download URL | sphinxcontrib_argdoc-0.1.3-py2.py3-none-any.whl |
|---|---|
| Size | 51.9 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
13485163bbaca777eb58fd53e2948531ffc4b71221b91644db889ab552724be7
|
|
BLAKE2b-256 checksum How to use checksums |
b89efad1332271473652d7702dfc89f76017cb6ef854581b3582c0ecdfe79f07
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
