From 0c65ef51c4f77658292b15952fd660f7722efbe0 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Sat, 22 Aug 2015 17:01:22 +0000 Subject: [PATCH] Add config options to the documentation Add the directive to include the configuration options to the library documentation. Depends-On: I549c8db98bf548dd0a7e8869a57301fa4096f78c (feature change in oslo.config) Depends-On: I89e3e4fd41ed4c989c2dd4c9cd1d7b7e806fa15a (global requirements change to update oslo.config version) Change-Id: Ibec7071027fc33374a73abc30f8f672380bae6ea --- doc/source/conf.py | 1 + doc/source/opts.rst | 15 ++++++++++++--- requirements.txt | 2 +- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 825fc278e..b52d5632a 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 8fc2bc736..9d94c185f 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 diff --git a/requirements.txt b/requirements.txt index 9ee9b1638..3eef893de 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,7 +5,7 @@ pbr<2.0,>=1.4 futurist>=0.1.2 # Apache-2.0 -oslo.config>=2.1.0 # Apache-2.0 +oslo.config>=2.3.0 # Apache-2.0 oslo.context>=0.2.0 # Apache-2.0 oslo.log>=1.8.0 # Apache-2.0 oslo.utils>=2.0.0 # Apache-2.0