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']
Once enabled, you can now use the plugin wherever necessary in the documentation.
.. click:: module:parser
:prog: hello-world
:nested: full
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.6.0.tar.gz
(17.2 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_click-2.6.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eac13400cd026f216084e7ffddb8fddde5638e411dddad71250da1e92675c4fe |
|
MD5 | 45a9d918be7abab29a110ba3b947e4d9 |
|
BLAKE2b-256 | bd1fbfe0f8ef3c4309d249372469f26f01a49765958826692a968e5c3073af91 |