Use the oslo.config sphinx module to generate sample

This commit switches to using the oslo.config sphinx extension to
generate a sample config instead of doing it manually in the docs' module.

Change-Id: I7032cb4f56c728911ffa5c6911eb504f53bc80af
This commit is contained in:
Matthew Treinish 2015-08-24 17:55:09 -04:00 committed by Mathew Odden
parent b7ad53bed3
commit 1719dfeb69
3 changed files with 8 additions and 17 deletions

.gitignore vendored
View File

@ -19,4 +19,4 @@ build

View File

@ -15,18 +15,6 @@ import sys
import os
import subprocess
# Build a tempest sample config file:
def build_sample_config(app):
root_dir = os.path.dirname(
os.path.dirname(os.path.dirname(os.path.abspath(__file__))))["oslo-config-generator", "--config-file",
"--output-file", "doc/source/_static/tempest.conf"],
def setup(app):
app.connect('builder-inited', build_sample_config)
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@ -42,9 +30,13 @@ def setup(app):
extensions = ['sphinx.ext.autodoc',
config_generator_config_file = '../../tools/config/config-generator.tempest.conf'
sample_config_basename = '_static/tempest'
todo_include_todos = True
# Add any paths that contain templates here, relative to this directory.

View File

@ -8,7 +8,6 @@ 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>`_.
The sample configuration can also be viewed in `file form <_static/tempest.conf.sample>`_.
.. include:: _static/tempest.conf
.. literalinclude:: _static/tempest.conf.sample