From ea7eaa4b0619f32549f1f1210665a2e1b5bb2240 Mon Sep 17 00:00:00 2001
From: Doug Hellmann <doug@doughellmann.com>
Date: Thu, 24 Sep 2015 17:15:51 +0000
Subject: [PATCH] add auto-generated docs for config options

Add automatically generated documentation for the configuration options
using oslo_config.sphinxext.

Change-Id: I8a58303b09aa5b0c04c083c85d50b87e3efe28e0
---
 doc/source/conf.py   | 5 +++--
 doc/source/index.rst | 1 +
 doc/source/opts.rst  | 9 +++++++++
 3 files changed, 13 insertions(+), 2 deletions(-)
 create mode 100644 doc/source/opts.rst

diff --git a/doc/source/conf.py b/doc/source/conf.py
index ceb9b64..454c6bc 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -23,7 +23,8 @@ sys.path.insert(0, os.path.abspath('../..'))
 extensions = [
     'sphinx.ext.autodoc',
     #'sphinx.ext.intersphinx',
-    'oslosphinx'
+    'oslosphinx',
+    'oslo_config.sphinxext',
 ]
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -72,4 +73,4 @@ latex_documents = [
 ]
 
 # Example configuration for intersphinx: refer to the Python standard library.
-#intersphinx_mapping = {'http://docs.python.org/': None}
\ No newline at end of file
+#intersphinx_mapping = {'http://docs.python.org/': None}
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 15faff4..ca87822 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -12,6 +12,7 @@ logging (like resource id's etc).
 
    installation
    usage
+   opts
    contributing
    history
 
diff --git a/doc/source/opts.rst b/doc/source/opts.rst
new file mode 100644
index 0000000..4e95f4d
--- /dev/null
+++ b/doc/source/opts.rst
@@ -0,0 +1,9 @@
+=======================
+ Configuration Options
+=======================
+
+oslo.log uses oslo.config to define and manage configuration options
+to allow the deployer to control how an application's logs are
+handled.
+
+.. show-options:: oslo.log