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.3.tar.gz
(9.7 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_click-1.0.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fff27530cdec6e8d0f64f2481022ac170ac1abc4bdfd0fd4fbb9b1d72b812e7f |
|
MD5 | 64b5d02ab043be1d797ac645a3c39afe |
|
BLAKE2b-256 | 57097f266933f4ac472b16d005a180b4096fee6b528f5b0de39c33a9a6182eb8 |