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: my_path.to.my_module
:func: my_func
:prog: hello-world
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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distributions
sphinx_click-1.0.0-py3.5.egg
(9.4 kB
view hashes)
sphinx_click-1.0.0-py2.7.egg
(9.4 kB
view hashes)
Close
Hashes for sphinx_click-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 733dd7a099ca8d95e709997c4e06215f4cbfd445ee69ce55f80844273801f5d2 |
|
MD5 | 35778644cea2bf67e7fc11333ea0f75e |
|
BLAKE2b-256 | b10fd64b19fce7026dfd885dcafea5af2020526bd992ebc882222320517a9a6e |