From 87fd1f49761a109f79308e1de96c1e0edcf465a5 Mon Sep 17 00:00:00 2001 From: Lukas Ruzicka Date: Tue, 24 Oct 2017 16:07:01 +0200 Subject: [PATCH] Use oslo.config-sphinxext to build the conf options Add the list of configuration options into the tree and reorganize the source files for the configuration guide. Change-Id: If93260edea2fc840a3d0954ff39cf859fcb727f6 --- doc/source/conf.py | 1 + doc/source/configuration/aodh-config-file.rst | 18 ++++++++++++++++++ .../configuration/aodh-config-options.rst | 7 +++++++ doc/source/configuration/index.rst | 18 ++++-------------- 4 files changed, 30 insertions(+), 14 deletions(-) create mode 100644 doc/source/configuration/aodh-config-file.rst create mode 100644 doc/source/configuration/aodh-config-options.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 854c87335..4644b4851 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -48,6 +48,7 @@ extensions = [ 'sphinxcontrib.pecanwsme.rest', 'stevedore.sphinxext', 'oslo_config.sphinxconfiggen', + 'oslo_config.sphinxext', 'sphinxcontrib.httpdomain', ] diff --git a/doc/source/configuration/aodh-config-file.rst b/doc/source/configuration/aodh-config-file.rst new file mode 100644 index 000000000..f1a135e10 --- /dev/null +++ b/doc/source/configuration/aodh-config-file.rst @@ -0,0 +1,18 @@ +.. _aodh-config-file: + +Aodh Sample Configuration File +============================== + +Configure Aodh by editing /etc/aodh/aodh.conf. + +No config file is provided with the source code, it will be created during +the installation. In case where no configuration file was installed, one +can be easily created by running:: + + aodh-config-generator + +The following is a sample Aodh configuration for adaptation and use. It is +auto-generated from Aodh when this documentation is built, and can also be +viewed in `file form <_static/aodh.conf.sample>`_. + +.. literalinclude:: ../_static/aodh.conf.sample diff --git a/doc/source/configuration/aodh-config-options.rst b/doc/source/configuration/aodh-config-options.rst new file mode 100644 index 000000000..2438607f5 --- /dev/null +++ b/doc/source/configuration/aodh-config-options.rst @@ -0,0 +1,7 @@ +Aodh Configuration Options +========================== + +.. show-options:: + :split-namespaces: + + aodh diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst index 736851f80..bd7bad316 100644 --- a/doc/source/configuration/index.rst +++ b/doc/source/configuration/index.rst @@ -1,22 +1,12 @@ .. _configuring: ========================== -Aodh Configuration Options +Configuration Guide ========================== -Aodh Sample Configuration File -============================== +.. toctree:: + aodh-config-file.rst + aodh-config-options.rst -Configure Aodh by editing /etc/aodh/aodh.conf. -No config file is provided with the source code, it will be created during -the installation. In case where no configuration file was installed, one -can be easily created by running:: - aodh-config-generator - -The following is a sample Aodh configuration for adaptation and use. It is -auto-generated from Aodh when this documentation is built, and can also be -viewed in `file form <_static/aodh.conf.sample>`_. - -.. literalinclude:: ../_static/aodh.conf.sample