openstack/deb-sahara
Code Issues Proposed changes

Merge "Publish sample conf to docs"

Browse Source
This commit is contained in:
Jenkins 2015-11-10 14:09:22 +00:00 committed by Gerrit Code Review
commit e1252dd704
5 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

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

6
doc/source/conf.py
View File

@ -37,11 +37,15 @@ sys.path.append(os.path.abspath('../bin'))
# Add any Sphinx extension module names here, as strings. They can be extensions # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 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: if not on_rtd:
extensions.append('oslosphinx') 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. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']

1
doc/source/config-generator.conf Symbolic link
View File

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

1
doc/source/index.rst
View File

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

8
doc/source/userdoc/sampleconfig.rst Normal file
View File

@ -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: