include sample config file in docs

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

Change-Id: I88a2429dd3cacd1d014b5b441b98fbfee7e1e208
changes/74/277574/1
Steve Martinelli 7 years ago
parent 8eacd48ede
commit 15668ded09
  1. 2
      .gitignore
  2. 4
      doc/source/conf.py
  3. 9
      doc/source/index.rst
  4. 12
      doc/source/sample_config.rst

2
.gitignore vendored

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

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

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

@ -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…
Cancel
Save