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 pip locally:
$ pip install .Usage
Enable the plugin in your Sphinx conf.py file:
extensions = ['sphinx_click']Once enabled, you can now use the plugin wherever necessary in the documentation.
.. click:: module:parser
:prog: hello-world
:nested: fullDetailed 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-4.2.0.tar.gz
(21.3 kB
view details)
Built Distribution
File details
Details for the file sphinx-click-4.2.0.tar.gz.
File metadata
- Download URL: sphinx-click-4.2.0.tar.gz
- Upload date:
- Size: 21.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8429705474ebb009de5603c35b6a7bfe8501dbdb12d847cbb01f18277d4b7d9a |
|
| MD5 | 316783267f3f071b3f332117a1979f70 |
|
| BLAKE2b-256 | 23e7fbb3fb37d3c42dcbf66fb054b254360fdaa3eaae401cb571fcc5a9c54fb4 |
File details
Details for the file sphinx_click-4.2.0-py3-none-any.whl.
File metadata
- Download URL: sphinx_click-4.2.0-py3-none-any.whl
- Upload date:
- Size: 8.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3ba8c97a40deaf09245c540accc4ac5c1d2942eaed0fa598403cdbf04a9cf95f |
|
| MD5 | 74414c7bb01711fcf8c0e5a6cf8c35d6 |
|
| BLAKE2b-256 | 45ff1fa4f0c033e38d90e9285d7d1ae046dcdc9dded17211ab49f4349b5deae1 |
