openstack/oslo.config
Code Issues Proposed changes
7f4e23bcef
oslo.config/doc/source/reference/sphinxext.rst
Doug Hellmann c9dd8f3a4b rearrange docs based on new standard layout 
Change-Id: I5a86fc144c628772c750e8626d0728e3782ea469
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-27 17:17:27 -04:00

1.2 KiB
Raw Blame History

Sphinx Integration

The oslo_config.sphinxext module defines a custom domain for documenting configuration options. The domain includes a directive and two roles.

Given a list of namespaces, show all of the options exported from them.

.. show-options::

   oslo.config
   oslo.log

To show each namespace separately, add the split-namespaces flag.

.. show-options::
   :split-namespaces:

   oslo.config
   oslo.log

To use an existing configuration file for the sample configuration generator, use the config-file option instead of specifying the namespaces inline. :

.. show-options::
   :config-file: etc/oslo-config-generator/glance-api.conf

Link to an option.

#. :oslo.config:option:`config_file`
#. :oslo.config:option:`DEFAULT.config_file`
  1. :oslo.configconfig_file
  2. :oslo.configDEFAULT.config_file

Link to an option group.

:oslo.config:group:`DEFAULT`

:oslo.configDEFAULT