ビルダークの構成¶

エントリポイントによるビルダークの検出¶

バージョン 1.6 で追加されました。

ビルダーク拡張はエントリポイントを使用して検出できるため、extensions 構成値に列挙する必要がありません。

ビルダーク拡張は、"sphinx.builders" グループにエントリポイントを定義する必要があります。エントリポイントの名前は、ビルダークの name 属性と一致する必要があります。これは sphinx-build --builder オプションに渡される名前です。エントリポイントの値は、拡張モジュールのドット付きの名前と同等である必要があります。以下は、'mybuilder' のエントリポイントを拡張の pyproject.toml で定義する方法の例です。

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

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