README.rst

sphinx-click

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-click

Alternatively, install from source by cloning this repo then running `setup.py`:

$ python setup.py install

Usage

Important

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.ext']

Once enabled, you can now use the plugin wherever necessary in the documentation.

.. click:: module:parser
   :prog: hello-world
   :show-nested:

Detailed information on the various options available is provided in the documentation.