include sample config file in docs

leverage oslo.config to rebuild our sample config file in our
docs

Change-Id: I88a2429dd3cacd1d014b5b441b98fbfee7e1e208
This commit is contained in:
Steve Martinelli 2016-02-08 16:40:58 -05:00
parent 8eacd48ede
commit 15668ded09
4 changed files with 27 additions and 0 deletions

2
.gitignore vendored
View File

@ -33,3 +33,5 @@ keystone/locale/*/LC_MESSAGES/*.mo
*.db
# Files created by releasenotes build
releasenotes/build
# sample config included in docs
doc/source/_static/keystone.conf.sample

View File

@ -41,9 +41,13 @@ extensions = ['sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'oslo_config.sphinxconfiggen',
'oslosphinx',
]
config_generator_config_file = '../../config-generator/keystone.conf'
sample_config_basename = '_static/keystone'
todo_include_todos = True
# Add any paths that contain templates here, relative to this directory.

View File

@ -87,6 +87,15 @@ Developers Documentation
services
online_schema_migration_examples
Sample Configuration File
=========================
.. toctree::
:maxdepth: 1
sample_config
Code Documentation
==================
.. toctree::

View File

@ -0,0 +1,12 @@
==============================
Keystone Configuration Options
==============================
The following is a sample keystone configuration for adaptation and use. It is
auto-generated from keystone when this documentation is built, so if you are
having issues with an option, please compare your version of keystone with the
version of this documentation.
The sample configuration can also be viewed in `file form <_static/keystone.conf.sample>`_.
.. literalinclude:: _static/keystone.conf.sample