Metadata-Version: 2.0
Name: sphinx-click
Version: 1.0.0
Summary: Sphinx extension that automatically documents click applications
Home-page: https://github.com/stephenfin/sphinx-click
Author: Stephen Finucane
Author-email: stephen@that.guru
License: MIT License
Keywords: sphinx
Platform: UNKNOWN
Requires-Dist: pbr (>=2.0)
Requires-Dist: sphinx (>=1.5,<2.0)

============
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.

__ http://www.sphinx-doc.org/
__ http://click.pocoo.org/

Installation
------------

Install the plugin using `pip`:

.. code-block:: shell

   $ pip install sphinx-click

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

.. code-block:: shell

   $ 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:

.. code-block:: python

   extensions = ['sphinx_click.ext']

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

.. code-block::

   .. click::
      :module: my_path.to.my_module
      :func: my_func
      :prog: hello-world

Detailed information on the various options available is provided in the
`documentation <https://sphinx-click.readthedocs.io>`_.



