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.7.0.tar.gz
(17.5 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_click-2.7.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea73616a31f546765348de8e60428e61be0fe249088c0b8026a14a79e09964bf |
|
MD5 | 95f2b268e4edba4f255d988ed6a2d0c6 |
|
BLAKE2b-256 | adeda39423b2d9af728b50f1e8c46b4b443ef183c83a65ce0799360ee5f6ebe4 |