Browse Source

Configuration documentation migrated

Documentation layout aligned with the OS standards.

The configuration page refactored, configuration options
documentation automatically generated by
oslo_config.sphinxext.

Closes-Bug: #1706175
Change-Id: I544d92d64833c0887b14509063334c39a0c428f1
changes/70/491870/2
Ilya Etingof 5 years ago
parent
commit
28da7b6745
  1. 7
      doc/source/conf.py
  2. 13
      doc/source/configuration/index.rst
  3. 7
      doc/source/configuration/ironic-inspector.rst
  4. 14
      doc/source/configuration/sample-config.rst
  5. 1
      doc/source/index.rst

7
doc/source/conf.py

@ -7,7 +7,9 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.viewcode',
]
'oslo_config.sphinxext',
'oslo_config.sphinxconfiggen']
try:
import openstackdocstheme
extensions.append('openstackdocstheme')
@ -38,6 +40,9 @@ master_doc = 'index'
project = u'Ironic Inspector'
copyright = u'OpenStack Foundation'
config_generator_config_file = '../../config-generator.conf'
sample_config_basename = '_static/ironic-inspector'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.

13
doc/source/configuration/index.rst

@ -0,0 +1,13 @@
Configuration Guide
===================
The ironic-inspector service operation is defined by a configuration
file. The overview of configuration file options follow.
.. toctree::
:maxdepth: 1
Ironic Inspector Configuration Options <ironic-inspector>
Sample Ironic Inspector Configuration <sample-config>

7
doc/source/configuration/ironic-inspector.rst

@ -0,0 +1,7 @@
---------------------
ironic-inspector.conf
---------------------
.. show-options::
:config-file: config-generator.conf

14
doc/source/configuration/sample-config.rst

@ -0,0 +1,14 @@
======================================
Ironic Inspector Configuration Options
======================================
The following is a sample Ironic Inspector configuration for
adaptation and use. It is auto-generated from Ironic Inspector
when this documentation is built, so if you find issues with an
option, please compare your version of Ironic Inspector with the
version of this documentation.
The sample configuration can also be downloaded as a :download:`file
</_static/ironic-inspector.conf.sample>`.
.. literalinclude:: /_static/ironic-inspector.conf.sample

1
doc/source/index.rst

@ -7,6 +7,7 @@ Using Ironic Inspector
:maxdepth: 2
install/index
configuration/index
user/index
admin/index

Loading…
Cancel
Save