From 28da7b67451c7208544d102cbe1c450ee4569587 Mon Sep 17 00:00:00 2001 From: Ilya Etingof Date: Tue, 8 Aug 2017 19:41:39 +0200 Subject: [PATCH] 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 --- doc/source/conf.py | 7 ++++++- doc/source/configuration/index.rst | 13 +++++++++++++ doc/source/configuration/ironic-inspector.rst | 7 +++++++ doc/source/configuration/sample-config.rst | 14 ++++++++++++++ doc/source/index.rst | 1 + 5 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 doc/source/configuration/index.rst create mode 100644 doc/source/configuration/ironic-inspector.rst create mode 100644 doc/source/configuration/sample-config.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index b40737fbc..8f58f1756 100644 --- a/doc/source/conf.py +++ b/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. diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst new file mode 100644 index 000000000..612edd9d0 --- /dev/null +++ b/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 + Sample Ironic Inspector Configuration + + diff --git a/doc/source/configuration/ironic-inspector.rst b/doc/source/configuration/ironic-inspector.rst new file mode 100644 index 000000000..3fc55fa7c --- /dev/null +++ b/doc/source/configuration/ironic-inspector.rst @@ -0,0 +1,7 @@ + +--------------------- +ironic-inspector.conf +--------------------- + +.. show-options:: + :config-file: config-generator.conf diff --git a/doc/source/configuration/sample-config.rst b/doc/source/configuration/sample-config.rst new file mode 100644 index 000000000..09b45ab21 --- /dev/null +++ b/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 +`. + +.. literalinclude:: /_static/ironic-inspector.conf.sample diff --git a/doc/source/index.rst b/doc/source/index.rst index cb600cadc..3925aebb3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -7,6 +7,7 @@ Using Ironic Inspector :maxdepth: 2 install/index + configuration/index user/index admin/index