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.3.0.tar.gz
(11.4 kB
view details)
Built Distribution
File details
Details for the file sphinx-click-1.3.0.tar.gz.
File metadata
- Download URL: sphinx-click-1.3.0.tar.gz
- Upload date:
- Size: 11.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0550d3e5dcd6244847bd0861ebe64101a2ef302913866e0ccd9095b2aa230051 |
|
| MD5 | f93f80996d0227837b6e86832d9717c0 |
|
| BLAKE2b-256 | 3881543c3cc73984427500ab9efbf5d64266ba2be5a0f6a327dab8e65704d0da |
File details
Details for the file sphinx_click-1.3.0-py2.py3-none-any.whl.
File metadata
- Download URL: sphinx_click-1.3.0-py2.py3-none-any.whl
- Upload date:
- Size: 5.7 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 404784f724504e3da2cb056767ba64955c4bfb9bfca8cfedd7142a962bafd70f |
|
| MD5 | d9a059399d0ab84a0a48ec7baec16056 |
|
| BLAKE2b-256 | 2f6bb39a0276a92109df25595570bd4e75b4139d26fcd64f62fe9553808854f5 |
