1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
====================
Sphinx Integration
====================
The ``oslo_config.sphinxext`` module defines a custom domain for
documenting configuration options. The domain includes a directive and
two roles.
.. rst:directive:: show-options
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
.. rst:role:: option
Link to an option.
::
#. :oslo.config:option:`config_file`
#. :oslo.config:option:`DEFAULT.config_file`
#. :oslo.config:option:`config_file`
#. :oslo.config:option:`DEFAULT.config_file`
.. rst:role:: group
Link to an option group.
::
:oslo.config:group:`DEFAULT`
:oslo.config:group:`DEFAULT`
|
