From 140f337779d617064160d80e87d29d34112a76d4 Mon Sep 17 00:00:00 2001
From: Joshua Harlow <harlowja@yahoo-inc.com>
Date: Thu, 24 Sep 2015 12:31:11 -0700
Subject: [PATCH] add auto-generated docs for config options

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

Change-Id: Ic8372b14cf5bbe423d098f4bb9cf4536c9336c2f
---
 doc/source/conf.py   | 4 ++--
 doc/source/index.rst | 1 +
 doc/source/opts.rst  | 8 ++++++++
 3 files changed, 11 insertions(+), 2 deletions(-)
 create mode 100644 doc/source/opts.rst

diff --git a/doc/source/conf.py b/doc/source/conf.py
index d055d1e..0599167 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -22,8 +22,8 @@ sys.path.insert(0, os.path.abspath('../..'))
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
     'sphinx.ext.autodoc',
-    #'sphinx.ext.intersphinx',
-    'oslosphinx'
+    'oslosphinx',
+    'oslo_config.sphinxext',
 ]
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 41e7b90..8fe606a 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -13,6 +13,7 @@ Contents
    installation
    api/modules
    usage
+   opts
    contributing
    history
 
diff --git a/doc/source/opts.rst b/doc/source/opts.rst
new file mode 100644
index 0000000..0827952
--- /dev/null
+++ b/doc/source/opts.rst
@@ -0,0 +1,8 @@
+=======================
+ Configuration Options
+=======================
+
+oslo.cache uses oslo.config to define and manage configuration options
+to allow the deployer to control how an application uses this library.
+
+.. show-options:: oslo.cache