Update doc on Sphinx integration process

This patch adds some minor information that also
should be taken into account  while integrate sphinx

Change-Id: I0f88b96a5858ce27ad330a647255c11762dd413a
This commit is contained in:
Vitalii Kulanov 2017-08-15 16:00:20 +03:00
parent 7a6df37f81
commit 5d77d6bd7b
1 changed files with 7 additions and 0 deletions

View File

@ -4,6 +4,13 @@ Sphinx Integration
cliff supports integration with Sphinx by way of a `Sphinx directives`__.
Before using the :rst:dir:`autoprogram-cliff` directive you must add
`'cliff.sphinxext'` extension module to a list of `extensions` in `conf.py`:
.. code-block:: python
extensions = ['cliff.sphinxext']
.. rst:directive:: .. autoprogram-cliff:: namespace
Automatically document an instance of :py:class:`cliff.command.Command`,