配置构建器

按切入点发现构建器

1.6 新版功能.

builder 的插件可以通过 切入点 来发现,这样它们就不必在 extensions 的配置值中列出。

Builder 插件应该在 sphinx.builder 组中定义一个切入点。切入点的名称需要与你的构建器的 name 属性相匹配,这是传递给 sphinx-build -b 选项的名称。切入点的值应该等于插件模块的带点名称。下面是一个例子,说明如何在扩展的 setup.py 中定义 mybuilder 的切入点

setup(
    # ...
    entry_points={
        'sphinx.builders': [
            'mybuilder = my.extension.module',
        ],
    }
)

注意,仍然需要在插件的 setup() 函数中使用 add_builder() 来注册构建器。