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.0.1.tar.gz
(13.6 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_click-2.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0c03d6ea0e4258c9c09646b6f745090ea8dd13e7e045903e4b789dfc02f7846 |
|
MD5 | a8a33da8fdd93f7140b9e96709999cb0 |
|
BLAKE2b-256 | 6190a5a9180d39c515e845b1bfcd9285ce409070e6b39af73c8bbb1edc7f1304 |