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.4.0.tar.gz
(13.1 kB
view details)
Built Distribution
File details
Details for the file sphinx-click-1.4.0.tar.gz.
File metadata
- Download URL: sphinx-click-1.4.0.tar.gz
- Upload date:
- Size: 13.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4b12575b51884185f6f3ade34a16e7e111f8495609c73844605ae194da14e7e1 |
|
| MD5 | 526153631381c242e67783dd4254528f |
|
| BLAKE2b-256 | 8d8dd9ed558e5d4fd20951c6b78a3a4991ad4d91e9f629c04e2bcf1e6152b94f |
File details
Details for the file sphinx_click-1.4.0-py2.py3-none-any.whl.
File metadata
- Download URL: sphinx_click-1.4.0-py2.py3-none-any.whl
- Upload date:
- Size: 7.0 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 911a83662f611aeeb32d71cf7b7ad0ecacc933ca1992880f3e11c6974854830a |
|
| MD5 | 049c9140e3e69b4ea4902a0b7ef56aa6 |
|
| BLAKE2b-256 | 9d429bf4984d52b1949501459f44b64d765e265fba23103588421c6665cc2ac0 |
