openstack
/
sahara
Code Issues Proposed changes

doc: generate the list of configuration option 

In addition to the existing sample of the configuration, also shows
the list of configuration options.

Change-Id: I79713ef57259a15be1a21d9a6d54140f2e0bd1a9
This commit is contained in:
Luigi Toscano 2017-08-16 16:15:43 +02:00
parent 96aa111c8d
commit 2dc8b4fe3b
3 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/conf.py
View File

@ -39,7 +39,7 @@ on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage',
'sphinx.ext.viewcode', 'sphinxcontrib.httpdomain', 'oslo_config.sphinxconfiggen',
'openstackdocstheme']
'oslo_config.sphinxext', 'openstackdocstheme']
# openstackdocstheme options
repository_name = 'openstack/sahara'

8
doc/source/configuration/descriptionconfig.rst Normal file
View File

@ -0,0 +1,8 @@
Configuration options
=====================
This section provides a list of the configuration options that can
be set in the sahara configuration file.
.. show-options::
:config-file: tools/config/config-generator.sahara.conf

2
doc/source/configuration/index.rst
View File

@ -2,7 +2,9 @@
Configuration Reference
=======================
.. toctree::
:maxdepth: 1
descriptionconfig
sampleconfig