x/deb-oslo.config
Code Issues Proposed changes
613fdcfd50
deb-oslo.config/doc/source/sphinxext.rst
Doug Hellmann ad440d7957 have show-options load the generator config file 
Add an option to the show-options directive to read existing
configuration files for the sample config generator instead of making
the author provide the list of namespaces inline.

Change-Id: I0ec46cc7aa820ae592d8e4e7b56ee98f0c5cbfb4
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2016-02-08 13:00:57 -05: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