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:
parent
96aa111c8d
commit
2dc8b4fe3b
|
@ -39,7 +39,7 @@ on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
||||||
# 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.viewcode', 'sphinxcontrib.httpdomain', 'oslo_config.sphinxconfiggen',
|
'sphinx.ext.viewcode', 'sphinxcontrib.httpdomain', 'oslo_config.sphinxconfiggen',
|
||||||
'openstackdocstheme']
|
'oslo_config.sphinxext', 'openstackdocstheme']
|
||||||
|
|
||||||
# openstackdocstheme options
|
# openstackdocstheme options
|
||||||
repository_name = 'openstack/sahara'
|
repository_name = 'openstack/sahara'
|
||||||
|
|
|
@ -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,7 +2,9 @@
|
||||||
Configuration Reference
|
Configuration Reference
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
|
descriptionconfig
|
||||||
sampleconfig
|
sampleconfig
|
||||||
|
|
Loading…
Reference in New Issue