summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2015-08-27 08:23:23 +0000
committerGerrit Code Review <review@openstack.org>2015-08-27 08:23:23 +0000
commite4817384b5edf101d1096e8a7846de14e8d99ada (patch)
treeba83eda62aa515adb74ef9af14337a821bd29e81
parent58c13f8c37895e27274671b176fa815e4f9f614b (diff)
parent0c65ef51c4f77658292b15952fd660f7722efbe0 (diff)
downloadoslo-messaging-e4817384b5edf101d1096e8a7846de14e8d99ada.tar.gz
Merge "Add config options to the documentation"
-rw-r--r--doc/source/conf.py1
-rw-r--r--doc/source/opts.rst15
2 files changed, 13 insertions, 3 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 825fc27..b52d563 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -12,6 +12,7 @@ extensions = [
'sphinx.ext.autodoc',
'oslosphinx',
'stevedore.sphinxext',
+ 'oslo_config.sphinxext',
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy
diff --git a/doc/source/opts.rst b/doc/source/opts.rst
index 8fc2bc7..9d94c18 100644
--- a/doc/source/opts.rst
+++ b/doc/source/opts.rst
@@ -1,6 +1,15 @@
-----------------------
-Configuration Options
-----------------------
+=======================
+ Configuration Options
+=======================
+
+oslo.messaging uses oslo.config to define and manage configuration
+options to allow the deployer to control how an application uses the
+underlying messaging system.
+
+.. show-options:: oslo.messaging
+
+API
+===
.. currentmodule:: oslo_messaging.opts