Merge "Use the oslo.config sphinx module to generate sample"

This commit is contained in:
Jenkins 2015-09-10 05:03:52 +00:00 committed by Gerrit Code Review
commit 0da49e92df
3 changed files with 8 additions and 17 deletions

2
.gitignore vendored
View File

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

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__))))
subprocess.call(["oslo-config-generator", "--config-file",
"tools/config/config-generator.tempest.conf",
"--output-file", "doc/source/_static/tempest.conf"],
cwd=root_dir)
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',
'sphinx.ext.todo',
'sphinx.ext.viewcode',
'oslosphinx'
'oslosphinx',
'oslo_config.sphinxconfiggen',
]
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
:code:
.. literalinclude:: _static/tempest.conf.sample