Use stevedore directive to document plugins

The point behind the addition of the stevedore.sphinxext extension is
"to document drivers and other types of plugins to make the available
sets built into projects easier to discover"(dhellman).

More details in the ML thread at
http://lists.openstack.org/pipermail/openstack-dev/2015-August/073338.html

Change-Id: Ib1d4c23a64cbd0010c88ff77b97b1173da302bed
This commit is contained in:
Dong Ma 2015-09-25 13:50:15 +08:00
parent ff3b461843
commit be1eed1183
4 changed files with 16 additions and 1 deletions

View File

@ -15,7 +15,8 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.todo',
'sphinx.ext.viewcode',
'oslosphinx']
'oslosphinx',
'stevedore.sphinxext']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

View File

@ -0,0 +1,6 @@
==========================
Available Notifier Drivers
==========================
.. list-plugins:: oslo.messaging.notify.drivers
:detailed:

View File

@ -0,0 +1,6 @@
====================
Trove API Extensions
====================
.. list-plugins:: trove.api.extensions
:detailed:

View File

@ -48,6 +48,8 @@ functionality, the following resources are provided.
dev/install
dev/manual_install.rst
dev/building_guest_images.rst
dev/notifier.rst
dev/trove_api_extensions.rst
* Source Code Repositories