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-1.0.2.tar.gz
(9.6 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_click-1.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a2c4d477c5c4498c9a2c91265a8df96fd86566e1bc76037727ed4ca88366fb1 |
|
MD5 | 8e5a92bbab9d0b4f533e9529c9f6a216 |
|
BLAKE2b-256 | 3125dd60f3eae876cc6db532ffb9f6d1031fd57cd2f64f783fc78ada688e2093 |