openstack
/
cliff
Code Issues Proposed changes

Merge "Update doc on Sphinx integration process"

This commit is contained in:
Jenkins 2017-08-22 22:31:42 +00:00 committed by Gerrit Code Review
parent 3df4937378 5d77d6bd7b
commit e27af50986
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/user/sphinxext.rst
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`,