Commit Graph

10 Commits

Author SHA1 Message Date
Takeshi KOMIYA
32c5e8346f Close #4460: extensions should return the version of data structure as metadata 2018-01-25 02:04:22 +09:00
Brecht Machiels
3dd256fe7d Do not include the builder class in the entry point
- use the entry point to load the extension module in the usual way
- update the documentation to reflect this change
2017-04-14 11:01:09 +02:00
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
Takeshi KOMIYA
da15090c83 Update docs for collectors API 2017-01-28 20:44:40 +09:00
Takeshi KOMIYA
8140ae33b5 Add doc/extdev/logging.rst 2017-01-02 12:59:51 +09:00
Takeshi KOMIYA
f89e3dfee3 Update docs about sphinx.parsers.Parser class 2016-01-17 19:18:02 +09:00
Georg Brandl
31452fc64d [WIP] parallel read 2014-09-22 14:51:47 +02:00
Georg Brandl
71cd2f7e50 Change extension setup() return value to a dictionary of metadata.
This makes it possible to introduce more metadata values later.
2014-09-22 11:06:42 +02:00
Georg Brandl
b6594d18d1 Add support for extensions to declare their version as a string returned from setup(). 2014-09-03 16:27:15 +02:00
Georg Brandl
883324fd6c Doc: move API docs in their own chapter and add more of it. 2014-01-20 17:21:44 +01:00