From 15668ded095f9dcee85ffcd228d6ad7fb27d9d38 Mon Sep 17 00:00:00 2001
From: Steve Martinelli <stevemar@ca.ibm.com>
Date: Mon, 8 Feb 2016 16:40:58 -0500
Subject: [PATCH] include sample config file in docs

leverage oslo.config to rebuild our sample config file in our
docs

Change-Id: I88a2429dd3cacd1d014b5b441b98fbfee7e1e208
---
 .gitignore                   |  2 ++
 doc/source/conf.py           |  4 ++++
 doc/source/index.rst         |  9 +++++++++
 doc/source/sample_config.rst | 12 ++++++++++++
 4 files changed, 27 insertions(+)
 create mode 100644 doc/source/sample_config.rst

diff --git a/.gitignore b/.gitignore
index 7d56a0f4f6..9c90971207 100644
--- a/.gitignore
+++ b/.gitignore
@@ -33,3 +33,5 @@ keystone/locale/*/LC_MESSAGES/*.mo
 *.db
 # Files created by releasenotes build
 releasenotes/build
+# sample config included in docs
+doc/source/_static/keystone.conf.sample
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 1b0121ff67..4527a4b284 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -41,9 +41,13 @@ extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.todo',
               'sphinx.ext.coverage',
               'sphinx.ext.viewcode',
+              'oslo_config.sphinxconfiggen',
               'oslosphinx',
               ]
 
+config_generator_config_file = '../../config-generator/keystone.conf'
+sample_config_basename = '_static/keystone'
+
 todo_include_todos = True
 
 # Add any paths that contain templates here, relative to this directory.
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 7cb1e2d0d6..8674025cdb 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -87,6 +87,15 @@ Developers Documentation
    services
    online_schema_migration_examples
 
+
+Sample Configuration File
+=========================
+
+.. toctree::
+    :maxdepth: 1
+
+    sample_config
+
 Code Documentation
 ==================
 .. toctree::
diff --git a/doc/source/sample_config.rst b/doc/source/sample_config.rst
new file mode 100644
index 0000000000..b170f8483c
--- /dev/null
+++ b/doc/source/sample_config.rst
@@ -0,0 +1,12 @@
+==============================
+Keystone Configuration Options
+==============================
+
+The following is a sample keystone configuration for adaptation and use. It is
+auto-generated from keystone when this documentation is built, so if you are
+having issues with an option, please compare your version of keystone with the
+version of this documentation.
+
+The sample configuration can also be viewed in `file form <_static/keystone.conf.sample>`_.
+
+.. literalinclude:: _static/keystone.conf.sample