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-2.3.0.tar.gz
(14.3 kB
view details)
Built Distribution
File details
Details for the file sphinx-click-2.3.0.tar.gz.
File metadata
- Download URL: sphinx-click-2.3.0.tar.gz
- Upload date:
- Size: 14.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 877d4e080f6ded85d566127c7256de8afae6ab4fdc7ef301f7cc906a8177e3e8 |
|
| MD5 | 1fb18f64123fa583d2dc7ef3e04ba583 |
|
| BLAKE2b-256 | 4d14a99b9974d07b1e785683e894f4f6da15791710faaa8fb214dd16fc0f60f0 |
File details
Details for the file sphinx_click-2.3.0-py2.py3-none-any.whl.
File metadata
- Download URL: sphinx_click-2.3.0-py2.py3-none-any.whl
- Upload date:
- Size: 7.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7be243c3f621b6a45e5ff8f644408ed1f7fd88004388b36c77a242e8f0386c4d |
|
| MD5 | 93a62def333e41cec6c9c79f80413208 |
|
| BLAKE2b-256 | ba5feb54a815acca31b9580a5256075c9a8aa7d1d00fd58706a2fd296909e638 |
