From be1eed118309c37c2a15d12a4768d6a5e2bf1772 Mon Sep 17 00:00:00 2001 From: Dong Ma Date: Fri, 25 Sep 2015 13:50:15 +0800 Subject: [PATCH] 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 --- doc/source/conf.py | 3 ++- doc/source/dev/notifier.rst | 6 ++++++ doc/source/dev/trove_api_extensions.rst | 6 ++++++ doc/source/index.rst | 2 ++ 4 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 doc/source/dev/notifier.rst create mode 100644 doc/source/dev/trove_api_extensions.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 98968e27e6..4fa3227a23 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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'] diff --git a/doc/source/dev/notifier.rst b/doc/source/dev/notifier.rst new file mode 100644 index 0000000000..27e6c1d005 --- /dev/null +++ b/doc/source/dev/notifier.rst @@ -0,0 +1,6 @@ +========================== +Available Notifier Drivers +========================== + +.. list-plugins:: oslo.messaging.notify.drivers + :detailed: diff --git a/doc/source/dev/trove_api_extensions.rst b/doc/source/dev/trove_api_extensions.rst new file mode 100644 index 0000000000..14ff591e66 --- /dev/null +++ b/doc/source/dev/trove_api_extensions.rst @@ -0,0 +1,6 @@ +==================== +Trove API Extensions +==================== + +.. list-plugins:: trove.api.extensions + :detailed: diff --git a/doc/source/index.rst b/doc/source/index.rst index 10a2581585..d9d9a4400b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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