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-2.4.0.tar.gz
(15.1 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_click-2.4.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ebf0c97ea590ca46ba8ab446ff1781773035e1dcb5dbdc339316b7f2575a333a |
|
MD5 | c64c340d709d721bb82c8af56ab7e546 |
|
BLAKE2b-256 | 9d776790524efe7cc1cfe46981193a7e1bb8381f9c1b5356f8d931a7dae10c6d |