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.4.0.tar.gz
(13.1 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_click-1.4.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 911a83662f611aeeb32d71cf7b7ad0ecacc933ca1992880f3e11c6974854830a |
|
MD5 | 049c9140e3e69b4ea4902a0b7ef56aa6 |
|
BLAKE2b-256 | 9d429bf4984d52b1949501459f44b64d765e265fba23103588421c6665cc2ac0 |