From b389faa22f08c046ff0ad052eb54e04b4274b799 Mon Sep 17 00:00:00 2001
From: Mathew Odden <mrodden@us.ibm.com>
Date: Thu, 30 Jul 2015 20:24:08 +0000
Subject: [PATCH] Include sample configuration in dev docs

Since including the sample configuration in tree is
becoming difficult to maintain, lets try moving it to
the developer docs. We still have the ability to view it
easily for users, and it can be auto-generated on doc build,
so it should also always be up to date.

Change-Id: I7ec2d76448feef5ecb9af7c238bbd12619fa31d8
---
 .gitignore                |  1 +
 doc/source/_static/.keep  |  0
 doc/source/index.rst      |  1 +
 doc/source/sampleconf.rst | 14 ++++++++++++++
 tox.ini                   |  5 ++++-
 5 files changed, 20 insertions(+), 1 deletion(-)
 create mode 100644 doc/source/_static/.keep
 create mode 100644 doc/source/sampleconf.rst

diff --git a/.gitignore b/.gitignore
index 1777cb99cc..043de0040b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -18,3 +18,4 @@ build
 .coverage*
 !.coveragerc
 cover/
+doc/source/_static/tempest.conf
diff --git a/doc/source/_static/.keep b/doc/source/_static/.keep
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/doc/source/index.rst b/doc/source/index.rst
index f925018aeb..93aca4979c 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -37,6 +37,7 @@ Tempest Configuration Guide
    :maxdepth: 2
 
    configuration
+   sampleconf
 
 ---------------------
 Command Documentation
diff --git a/doc/source/sampleconf.rst b/doc/source/sampleconf.rst
new file mode 100644
index 0000000000..2a7297116b
--- /dev/null
+++ b/doc/source/sampleconf.rst
@@ -0,0 +1,14 @@
+.. _tempest-sampleconf:
+
+Sample Configuration File
+==========================
+
+The following is a sample Tempest configuration for adaptation and use. It is
+auto-generated from Tempest when this documentation is built, so
+if you are having issues with an option, please compare your version of
+Tempest with the version of this documentation.
+
+The sample configuration can also be viewed in `file form <_static/tempest.conf>`_.
+
+.. include:: _static/tempest.conf
+   :code:
diff --git a/tox.ini b/tox.ini
index 389fee2e69..cd1879ef06 100644
--- a/tox.ini
+++ b/tox.ini
@@ -108,7 +108,10 @@ commands =
 commands = {posargs}
 
 [testenv:docs]
-commands = python setup.py build_sphinx {posargs}
+# The sample config file we generate is included in the sphinxdoc, so build that first.
+commands =
+   oslo-config-generator --config-file tools/config/config-generator.tempest.conf --output-file doc/source/_static/tempest.conf
+   python setup.py build_sphinx {posargs}
 
 [testenv:pep8]
 commands =