From 46d1e89c2746f1c5bbaa219fe92d01bc71197b04 Mon Sep 17 00:00:00 2001
From: ricolin <rico.lin@easystack.cn>
Date: Sat, 7 Oct 2017 02:24:11 +0800
Subject: [PATCH] include sample config file in docs

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

Change-Id: I359e63fad43a5fcde4fe30a97cbed8f4f71961c5
---
 .gitignore                                 |  3 +++
 doc/source/conf.py                         |  5 +++++
 doc/source/configuration/index.rst         |  3 ++-
 doc/source/configuration/sample_config.rst | 12 ++++++++++++
 4 files changed, 22 insertions(+), 1 deletion(-)
 create mode 100644 doc/source/configuration/sample_config.rst

diff --git a/.gitignore b/.gitignore
index 17a741a88e..5babaa2c2d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -35,3 +35,6 @@ doc/source/_static/heat.policy.yaml.sample
 
 # Files created by releasenotes build
 releasenotes/build
+
+# sample config included in docs
+doc/source/_static/heat.conf.sample
diff --git a/doc/source/conf.py b/doc/source/conf.py
index b4b8cf01d5..fd07385bdc 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -78,6 +78,7 @@ extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.viewcode',
               'sphinx.ext.doctest',
               'openstackdocstheme',
+              'oslo_config.sphinxconfiggen',
               'oslo_policy.sphinxext',
               'oslo_policy.sphinxpolicygen',
               'ext.resources',
@@ -88,6 +89,10 @@ extensions = ['sphinx.ext.autodoc',
 policy_generator_config_file = '../../etc/heat/heat-policy-generator.conf'
 sample_policy_basename = '_static/heat'
 
+# oslo_config.sphinxconfiggen options
+config_generator_config_file = '../../config-generator.conf'
+sample_config_basename = '_static/heat'
+
 # openstackdocstheme options
 repository_name = 'openstack/heat'
 bug_project = 'heat'
diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst
index 6a8970d0b2..72376426da 100644
--- a/doc/source/configuration/index.rst
+++ b/doc/source/configuration/index.rst
@@ -9,4 +9,5 @@ Configuring Heat
    clients.rst
    config-options.rst
    logs.rst
-   sample_policy.rst
+   sample_config.rst
+   sample_policy.rst
\ No newline at end of file
diff --git a/doc/source/configuration/sample_config.rst b/doc/source/configuration/sample_config.rst
new file mode 100644
index 0000000000..f572f48448
--- /dev/null
+++ b/doc/source/configuration/sample_config.rst
@@ -0,0 +1,12 @@
+=========================
+Heat Configuration Sample
+=========================
+
+The following is a sample heat configuration for adaptation and use. It is
+auto-generated from heat when this documentation is built, so if you are
+having issues with an option, please compare your version of heat with the
+version of this documentation.
+
+The sample configuration can also be downloaded in `file form <../_static/heat.conf.sample>`_.
+
+.. literalinclude:: ../_static/heat.conf.sample