Add overview of config options

This uses the attr-overview directive in the dependent change to add
an overview of the configuration options for each section.

Change-Id: I70c741c8192c7151af89e0902d6eca96da1c4891
Depends-On: https://review.openstack.org/604980
This commit is contained in:
Ian Wienand 2018-09-25 17:00:04 +10:00
parent 8d54917488
commit fc8827b55b
1 changed files with 20 additions and 0 deletions

View File

@ -21,6 +21,12 @@ and ``providers`` sections::
The following sections are available. All are required unless
otherwise indicated.
.. attr-overview::
:maxdepth: 1
Options
-------
.. attr:: webapp
Define the webapp endpoint port and listen address
@ -344,6 +350,13 @@ otherwise indicated.
OpenStack Driver
----------------
Selecting the OpenStack driver adds the following options to the
:attr:`providers` section of the configuration.
.. attr-overview::
:prefix: providers.openstack
:maxdepth: 3
.. attr:: providers.openstack
Specifying the ``openstack`` driver for a provider adds the
@ -889,6 +902,13 @@ OpenStack Driver
Static Provider
---------------
Selecting the static driver adds the following options to the
:attr:`providers` section of the configuration.
.. attr-overview::
:prefix: providers.static
:maxdepth: 3
.. attr:: providers.static
:type: list