Sphinx extension that automatically documents click applications
Install the plugin using pip:
$ pip install sphinx-click
Alternatively, install from source by cloning this repo then running pip locally:
$ pip install .
To document a click-based application, both the application itself and any additional dependencies required by that application must be installed.
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: full
Detailed information on the various options available is provided in the documentation.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for sphinx_click-4.2.0-py3-none-any.whl