Sphinx 集成¶

oslo_config.sphinxext 模块定义了一个用于记录配置选项的自定义域。该域包括一个指令和两个角色。

.. show-options::¶

给定一个命名空间列表，显示从这些命名空间导出的所有选项。

.. show-options::

   oslo.config
   oslo.log

要单独显示每个命名空间，请添加 split-namespaces 标志。

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

   oslo.config
   oslo.log

要为示例配置生成器使用现有的配置文件，请使用 config-file 选项，而不是内联指定命名空间。

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

:option:¶

链接到选项。

#. :oslo.config:option:`config_file`
#. :oslo.config:option:`DEFAULT.config_file`

:group:¶

链接到选项组。

:oslo.config:group:`DEFAULT`

Sphinx 集成