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.4.tar.gz
(9.8 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_click-1.0.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcab79e81120256f21ae86e099186a78abfe0fff45002b33ed04ccf38dba8490 |
|
MD5 | f2ed40f4e9cec136e2abbfe4b5fc3e8c |
|
BLAKE2b-256 | c7112a6470a35cbe6a683fa435f450d7cbeb1189679451d67868480b3958a053 |