Publish sample conf to docs

Generate sample config file before each docs build and publish it

Change-Id: I688d83e2c0e779582395275d0aaf7cc62e55eabd

.gitignore

@@ -23,3 +23,4 @@ sdist
 target
 tools/lintstack.head.py
 tools/pylint_exceptions
+doc/source/sample.config

doc/source/conf.py

@@ -37,11 +37,15 @@ sys.path.append(os.path.abspath('../bin'))
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage',
-              'sphinx.ext.pngmath', 'sphinx.ext.viewcode', 'sphinxcontrib.httpdomain']
+              'sphinx.ext.pngmath', 'sphinx.ext.viewcode', 'sphinxcontrib.httpdomain',
+              'oslo_config.sphinxconfiggen']
 
 if not on_rtd:
     extensions.append('oslosphinx')
 
+config_generator_config_file = 'config-generator.conf'
+config_sample_basename = 'sahara'
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

doc/source/config-generator.conf

@@ -0,0 +1 @@
+../../tools/config/config-generator.sahara.conf

doc/source/index.rst

@@ -30,6 +30,7 @@ User guide
    userdoc/dashboard.guide
    userdoc/advanced.configuration.guide
    userdoc/upgrade.guide
+   userdoc/sampleconfig
 
 **How To**
 

doc/source/userdoc/sampleconfig.rst

@@ -0,0 +1,8 @@
+Sample sahara.conf file
+=======================
+
+This is an automatically generated sample of the sahara.conf file.
+
+.. literalinclude:: ../sample.config
+   :language: ini
+   :linenos: