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.
Alternative
This plugin is perfect to document a Click-based CLI in Sphinx, as it properly renders the help screen and its options in nice HTML with deep links and styling.
However, if you are looking to document the source code of a Click-based CLI, and the result of its execution, you might want to check out click-extra. The latter provides the .. click:example:: and .. click:run:: Sphinx directives so you can capture and render, with full colors, the result of your CLI in your 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
Built Distribution
File details
Details for the file sphinx-click-5.0.1.tar.gz.
File metadata
- Download URL: sphinx-click-5.0.1.tar.gz
- Upload date:
- Size: 26.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.17
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fcc7df15e56e3ff17ebf446cdd316c2eb79580b37c49579fba11e5468802ef25 |
|
| MD5 | 5b3e21ddfebe909b47eeba1478e71746 |
|
| BLAKE2b-256 | 051341f22575f85512b4b8f516ea4577f8cef81635487a384ccb9c5f96832390 |
File details
Details for the file sphinx_click-5.0.1-py3-none-any.whl.
File metadata
- Download URL: sphinx_click-5.0.1-py3-none-any.whl
- Upload date:
- Size: 9.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.17
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 31836ca22f746d3c26cbfdfe0c58edf0bca5783731a0b2e25bb6d59800bb75a1 |
|
| MD5 | 3d5cd9ee7af3d5d3e0c848b33d44b6cf |
|
| BLAKE2b-256 | 295bf6727206f99873cde3277d51807284b612e8c52a0351facdf32243fc7b50 |
