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-clickAlternatively, install from source by cloning this repo then running setup.py:
$ python setup.py installUsage
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.
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 details)
Built Distribution
File details
Details for the file sphinx-click-1.0.4.tar.gz.
File metadata
- Download URL: sphinx-click-1.0.4.tar.gz
- Upload date:
- Size: 9.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 612a00b497e0434271d2ef808369d627d0002936d66ec21e11c07e79f886fbd5 |
|
| MD5 | 3f6d983e3ba6b5f1a1c968b10515eff0 |
|
| BLAKE2b-256 | f1ffd4158b5619949cbd38fd77961112466c29c889914bcda03a7a8637b80877 |
File details
Details for the file sphinx_click-1.0.4-py2.py3-none-any.whl.
File metadata
- Download URL: sphinx_click-1.0.4-py2.py3-none-any.whl
- Upload date:
- Size: 6.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fcab79e81120256f21ae86e099186a78abfe0fff45002b33ed04ccf38dba8490 |
|
| MD5 | f2ed40f4e9cec136e2abbfe4b5fc3e8c |
|
| BLAKE2b-256 | c7112a6470a35cbe6a683fa435f450d7cbeb1189679451d67868480b3958a053 |
