配置构建器¶

发现入口点的构建器¶

Added in version 1.6.

builder 扩展可以通过 entry points 被发现,因此不必在 extensions 配置值中列出.

构建器扩展应该在 "sphinx.builders" 组中定义一个入口点.入口点的名称需要与构建器的:attr:~.Builder.name 属性匹配,该属性是传递给:option:sphinx-build –builder 选项的名称.入口点的值应该等于扩展模块的点分名称.以下是如何在扩展的 pyproject.toml 中定义’mybuilder’的入口点的示例

[project.entry-points."sphinx.builders"]
mybuilder = "my.extension.module"

注意,在扩展的 setup() 函数中仍然需要使用 add_builder() 注册构建器.