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

@@ -18,3 +18,4 @@ build
 .coverage*
 !.coveragerc
 cover/
+doc/source/_static/tempest.conf

doc/source/index.rst

@@ -37,6 +37,7 @@ Tempest Configuration Guide
    :maxdepth: 2
 
    configuration
+   sampleconf
 
 ---------------------
 Command Documentation

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:

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 =