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.1.0.tar.gz
(10.8 kB
view details)
Built Distribution
File details
Details for the file sphinx-click-1.1.0.tar.gz.
File metadata
- Download URL: sphinx-click-1.1.0.tar.gz
- Upload date:
- Size: 10.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0eef2d55ee4b5ebc448d8aa52e6084b5085fd2e7852d7571abb090411217c4df |
|
| MD5 | c20b4835218ec5edbd0d417e886c042c |
|
| BLAKE2b-256 | 191e7ec60e550f85bf0cda9fe648934dccbf627bd5e15fd78d9248480a77b1dd |
File details
Details for the file sphinx_click-1.1.0-py2.py3-none-any.whl.
File metadata
- Download URL: sphinx_click-1.1.0-py2.py3-none-any.whl
- Upload date:
- Size: 7.1 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c2680d84e8608bf47141e16924f1a981c653caff0faefe47a1d41c1438fbd5b4 |
|
| MD5 | 0d30bc359aaad789bf66b00fe25a0941 |
|
| BLAKE2b-256 | d56cbff00c459318eaef707dbfa5b5db8c10f4e71d0efb93a798f7a7131199af |
