Sphinx Oslo 示例配置生成

oslo.config 包含一个 sphinx 扩展，用于在每次 sphinx 构建的开始时生成一个示例配置文件。要激活此扩展，请将 oslo_config.sphinxconfiggen 添加到 sphinx conf.py 文件中的扩展列表。

然后，您只需要使用 config_generator_config_file 选项来指向告诉配置生成器如何生成示例配置的配置文件。如果未指定或未指向真实文件，则将跳过示例配置文件生成。

要生成多个文件，请将 config_generator_config_file 设置为包含输入文件名和输出文件基本名的元组列表。

输出值可以是 None，在这种情况下，名称将从输入值中获取。

输入名称可以是完整路径或相对于文档源目录的值。

例如

config_generator_config_file = [
    ('../../etc/glance-api.conf', 'api'),
    ('../../etc/glance-cache.conf', 'cache'),
    ('../../etc/glance-glare.conf', None),
    ('../../etc/glance-registry.conf', None),
    ('../../etc/glance-scrubber.conf', None),
]

生成输出文件 api.conf.sample、cache.conf.sample、glance-glare.conf.sample、glance-registry.conf.sample 和 glance-scrubber.conf.sample。

输出文件名

默认情况下，sphinx 插件将生成示例配置文件并将其命名为 sample.config。但是，如果出于任何原因您希望名称更具体地与项目名称相关联，可以使用 sample_config_basename 配置选项来指定项目名称。如果设置了该选项，输出文件名将是该值加上 .conf.sample 扩展名。例如，如果您将值设置为“nova”，则输出文件名将是“nova.conf.sample”。您还可以在此值中包含文档源目录下的子目录。