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-3.0.2.tar.gz
(19.8 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_click-3.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8529a02bea8cd2cd47daba2f71d7935c727c89d70baabec7fca31af49a0c379f |
|
MD5 | 36ea3f5bf8eb110b28e90bf496987c10 |
|
BLAKE2b-256 | 6b9a748869e9bf2ca4bdccb2a2fc2b7112ecc555255563de5d68b5b1a1b36289 |