Merge "Include sample configuration in dev docs"
diff --git a/.gitignore b/.gitignore
index 1777cb9..043de00 100644
--- a/.gitignore
+++ b/.gitignore
@@ -18,3 +18,4 @@
.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 0000000..e69de29
--- /dev/null
+++ b/doc/source/_static/.keep
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 44bfc88..e9f2161 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -38,6 +38,7 @@
:maxdepth: 2
configuration
+ sampleconf
---------------------
Command Documentation
diff --git a/doc/source/sampleconf.rst b/doc/source/sampleconf.rst
new file mode 100644
index 0000000..2a72971
--- /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 389fee2..cd1879e 100644
--- a/tox.ini
+++ b/tox.ini
@@ -108,7 +108,10 @@
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 =