Sphinx extension that automatically documents click applications
Reason this release was yanked:
https://github.com/click-contrib/sphinx-click/issues/99
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.1.tar.gz
(21.2 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_click-4.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7569b9eec0102344a4f9fa18b1d916624ab71a47a95d2ef6113b5b7f9402bc2b |
|
MD5 | 122000a28ccf4ceb1f7ce76426764806 |
|
BLAKE2b-256 | dc2df993bfd724d2d524dbde11c64dbd28660472a7ec822ebd56853abe7a85ce |