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']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.0.3.tar.gz
(21.3 kB
view details)
Built Distribution
File details
Details for the file sphinx-click-4.0.3.tar.gz.
File metadata
- Download URL: sphinx-click-4.0.3.tar.gz
- Upload date:
- Size: 21.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a1aacf00cfe11550a2211014617c426a94af8638f1ce735b5d9998cccf1a1edb |
|
| MD5 | 627832eb9b93c6f2d1ba1327fa80e743 |
|
| BLAKE2b-256 | 98e88340eac6fccde4670bab4a876322082390dae80d9a7334880b274c0e03b8 |
File details
Details for the file sphinx_click-4.0.3-py3-none-any.whl.
File metadata
- Download URL: sphinx_click-4.0.3-py3-none-any.whl
- Upload date:
- Size: 8.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4c4b43386ff6304e47ae0467da9c980786eb3c1317cd6f488524c18931627c04 |
|
| MD5 | bfa400b8f58b7409f6831a50488c74ae |
|
| BLAKE2b-256 | ffd5c33aab431f1013a550c576ee6fbb34b38f6620d7312723a6ed31f85d6ff9 |
