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.1.0.tar.gz
(21.1 kB
view details)
Built Distribution
File details
Details for the file sphinx-click-4.1.0.tar.gz.
File metadata
- Download URL: sphinx-click-4.1.0.tar.gz
- Upload date:
- Size: 21.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fedebd39991243ec5cfa1c9e483db7ea2621b3df2012315c89c6f1f3722f192b |
|
| MD5 | 0d15fea78be70307a817532026d272aa |
|
| BLAKE2b-256 | 2dd49e689431404770074cce9c522063ef8ddf73adcb9e3c5e5b574ab1a764e1 |
File details
Details for the file sphinx_click-4.1.0-py3-none-any.whl.
File metadata
- Download URL: sphinx_click-4.1.0-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.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 60d6507bf623e20e9cbab732d19fc4890cc36a394c82ba8e2320f9f9fdc4571e |
|
| MD5 | d13f411ccc71096936e72a5db92eb610 |
|
| BLAKE2b-256 | e3c1b04dcecf8f691d937a596975465144536eeeb3dd17c0ec8e8cc5f69ad64d |
