Sphinx extension that automatically documents click applications
Project description
sphinx-click is a Sphinx plugin that allows you to automatically extract documentation from a click-based application and include it in your docs.
Installation
Install the plugin using pip:
$ pip install sphinx-click
Alternatively, install from source by cloning this repo then running setup.py:
$ python setup.py install
Usage
Enable the plugin in your Sphinx conf.py file:
extensions = ['sphinx_click.ext']
Once enabled, you can now use the plugin wherever necessary in the documentation.
.. click:: module:parser
:prog: hello-world
:show-nested:
Detailed information on the various options available is provided in the documentation.
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
sphinx-click-2.3.0.tar.gz
(14.3 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_click-2.3.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7be243c3f621b6a45e5ff8f644408ed1f7fd88004388b36c77a242e8f0386c4d |
|
MD5 | 93a62def333e41cec6c9c79f80413208 |
|
BLAKE2b-256 | ba5feb54a815acca31b9580a5256075c9a8aa7d1d00fd58706a2fd296909e638 |