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-4.0.2.tar.gz
(21.2 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_click-4.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a158612397e094e4537a381e101f8d44acb794885ba614a804b548d62570bab |
|
MD5 | f70f11bc49b50718ff682ba41cec8c02 |
|
BLAKE2b-256 | bfbea012699c74f21847bb89eeb77629105275e5cd43715458276327a483497d |