sphinx/doc/extdev
Brecht Machiels 405ef96d2a Find third-party builders by entry point
A builder is uniquely identified by its name, which can be used as an
entry point in the 'sphinx.builders' entry point group. This obviates
the need to register the builder as an extension.

The built-in builders are still loaded as before. New third-party builders
should provide an entry point in their setup.py:

    entry_points={
        'sphinx.builders': [
            'mybuilder = mypackage.mymodule:MyBuilder',
        ],
    }

Like before, builders should define a setup(app) function in the
'mypackage.module' module to define configuration variables etc. It is
no longer necessary to register the builder using Sphinx.add_builder().

Existing builders can still be loaded the traditional way, by including
their module name in the extensions list in conf.py.
2017-04-10 13:04:41 +02:00
..
appapi.rst Add Sphinx.add_post_transform() 2017-03-10 10:49:08 +09:00
builderapi.rst Doc: move API docs in their own chapter and add more of it. 2014-01-20 17:21:44 +01:00
collectorapi.rst Update docs for collectors API 2017-01-28 20:44:40 +09:00
domainapi.rst Doc: move API docs in their own chapter and add more of it. 2014-01-20 17:21:44 +01:00
envapi.rst Fix #1900: BuildEnvironment.srcdir documentation gives false information 2016-01-07 14:18:40 +09:00
index.rst Find third-party builders by entry point 2017-04-10 13:04:41 +02:00
logging.rst logging module docs 2017-02-07 20:06:28 +01:00
markupapi.rst doc: Use AutodocReporter at example of nested_parse_with_titles() 2016-09-07 15:46:20 +09:00
nodes.rst Drop deprecated termsep node 2017-01-05 13:44:04 +09:00
parserapi.rst Update docs about sphinx.parsers.Parser class 2016-01-17 19:18:02 +09:00
tutorial.rst Update docs 2017-03-10 16:43:27 +09:00