Configuring builders

Discover builders by entry point

Added in version 1.6.

builder extensions can be discovered by means of entry points so that they do not have to be listed in the extensions configuration value.

Builder extensions should define an entry point in the "" 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

mybuilder = "my.extension.module"

Note that it is still necessary to register the builder using add_builder() in the extension’s setup() function.