ビルダーの設定

エントリーポイント別ビルダー紹介

Added in version 1.6.

builder 拡張は entry points を使って検出することができますので、 extensions 設定値にリストする必要はありません。

Builder extensions should define an entry point in the "sphinx.builders" group. The name of the entry point needs to match your builder's name attribute, which is the name passed to the sphinx-build -b option. The entry point value should equal the dotted name of the extension module. Here is an example of how an entry point for 'mybuilder' can be defined in the extension's pyproject.toml

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

この場合でも、拡張の setup() 関数の add_builder() を使用してビルダーを登録する必要があることに注意してください。