Konfiguration von Buildern¶
Builder per Entry Point entdecken¶
Hinzugefügt in Version 1.6.
Builder-Erweiterungen können mittels Entry Points entdeckt werden, sodass sie nicht in der extensions-Konfigurationsoption aufgeführt werden müssen.
Builder-Erweiterungen sollten einen Entry Point in der Gruppe "sphinx.builders" definieren. Der Name des Entry Points muss mit dem name-Attribut Ihres Builders übereinstimmen, was der Name ist, der an die Option sphinx-build --builder übergeben wird. Der Wert des Entry Points sollte dem gepunkteten Namen des Erweiterungsmoduls entsprechen. Hier ist ein Beispiel, wie ein Entry Point für ‘mybuilder’ in der pyproject.toml der Erweiterung definiert werden kann:
[project.entry-points."sphinx.builders"]
mybuilder = "my.extension.module"
Beachten Sie, dass es immer noch notwendig ist, den Builder mittels add_builder() in der setup()-Funktion der Erweiterung zu registrieren.