openstack
/
aodh
Code Issues Proposed changes

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
This commit is contained in:
Lukas Ruzicka 2017-10-24 16:07:01 +02:00
parent bee1aeaa3f
commit 87fd1f4976
4 changed files with 30 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/conf.py
View File

@ -48,6 +48,7 @@ extensions = [
'sphinxcontrib.pecanwsme.rest',
'stevedore.sphinxext',
'oslo_config.sphinxconfiggen',
'oslo_config.sphinxext',
'sphinxcontrib.httpdomain',
]

18
doc/source/configuration/aodh-config-file.rst Normal file
View File

@ -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

7
doc/source/configuration/aodh-config-options.rst Normal file
View File

@ -0,0 +1,7 @@
Aodh Configuration Options
==========================
.. show-options::
:split-namespaces:
aodh

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

@ -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