配置构建器¶
通过入口点发现构建器¶
1.6 版本新增。
构建器 扩展可以通过 入口点 来发现,因此它们不必列在 extensions
配置值中。
构建器扩展应该在 "sphinx.builders"
组中定义一个入口点。入口点的名称需要与你的构建器的 name
属性匹配,该属性是传递给 sphinx-build --builder
选项的名称。入口点的值应该等于扩展模块的点分名称。以下是如何在扩展的 pyproject.toml
中定义 ‘mybuilder’ 的入口点的示例
[project.entry-points."sphinx.builders"]
mybuilder = "my.extension.module"
请注意,仍然需要使用扩展的 setup()
函数中的 add_builder()
注册构建器。