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: my_path.to.my_module
:func: my_func
:prog: hello-worldDetailed 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
File details
Details for the file sphinx-click-0.0.1.dev2.tar.gz.
File metadata
- Download URL: sphinx-click-0.0.1.dev2.tar.gz
- Upload date:
- Size: 9.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ee876a3ae641b4c7d29ec1d67769bcf45a6604e3b91d848e83ee7f06f57eefe4 |
|
| MD5 | c0f4789d37495f24a08305219327a7a7 |
|
| BLAKE2b-256 | 44ff8e76ed20745779b061a22ad0c0ceb3a317ca59ded99bcc6108df6bc9af9d |
