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:
parent
8eacd48ede
commit
15668ded09
2
.gitignore
vendored
2
.gitignore
vendored
@ -33,3 +33,5 @@ keystone/locale/*/LC_MESSAGES/*.mo
|
|||||||
*.db
|
*.db
|
||||||
# Files created by releasenotes build
|
# Files created by releasenotes build
|
||||||
releasenotes/build
|
releasenotes/build
|
||||||
|
# sample config included in docs
|
||||||
|
doc/source/_static/keystone.conf.sample
|
||||||
|
@ -41,9 +41,13 @@ extensions = ['sphinx.ext.autodoc',
|
|||||||
'sphinx.ext.todo',
|
'sphinx.ext.todo',
|
||||||
'sphinx.ext.coverage',
|
'sphinx.ext.coverage',
|
||||||
'sphinx.ext.viewcode',
|
'sphinx.ext.viewcode',
|
||||||
|
'oslo_config.sphinxconfiggen',
|
||||||
'oslosphinx',
|
'oslosphinx',
|
||||||
]
|
]
|
||||||
|
|
||||||
|
config_generator_config_file = '../../config-generator/keystone.conf'
|
||||||
|
sample_config_basename = '_static/keystone'
|
||||||
|
|
||||||
todo_include_todos = True
|
todo_include_todos = True
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
|
@ -87,6 +87,15 @@ Developers Documentation
|
|||||||
services
|
services
|
||||||
online_schema_migration_examples
|
online_schema_migration_examples
|
||||||
|
|
||||||
|
|
||||||
|
Sample Configuration File
|
||||||
|
=========================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
sample_config
|
||||||
|
|
||||||
Code Documentation
|
Code Documentation
|
||||||
==================
|
==================
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
12
doc/source/sample_config.rst
Normal file
12
doc/source/sample_config.rst
Normal 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
|
Loading…
Reference in New Issue
Block a user