Commit Graph

187 Commits

Author SHA1 Message Date
Takeshi KOMIYA
d505d232de
Merge pull request #4884 from tk0miya/4873_adjust_word-break
Fix #4873: Adjust word-break of deprecated-APIs table
2018-04-22 21:31:56 +09:00
Takeshi KOMIYA
d97dc05b37 Fix #4873: Adjust word-break of deprecated-APIs table 2018-04-22 20:00:46 +09:00
Takeshi KOMIYA
5897d45cc6 Merge branch 'master' into refactor_config 2018-04-22 18:56:04 +09:00
Takeshi KOMIYA
1542622cf7
Merge pull request #4853 from tk0miya/4810_order_of_transforms
Change processing order of reading a document
2018-04-21 19:17:27 +09:00
Takeshi KOMIYA
6b14cd3bd6 Change priority of versioning doctrees 2018-04-21 11:28:23 +09:00
Takeshi KOMIYA
abf8999ce7 Deprecate footnotes helpers 2018-04-20 22:14:49 +09:00
Jon Dufresne
365c93f227 Update all pypi.python.org URLs to pypi.org
For details on the new PyPI, see the blog post:

https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html
2018-04-18 19:51:48 -07:00
Takeshi KOMIYA
b35198d847 Deprecate highlightlang directive
highlightlang directive is not documented, and marked as old in v0.2.
2018-04-15 00:33:02 +09:00
Takeshi KOMIYA
c35eb6fade
Merge pull request #4815 from tk0miya/refine_add_css_file
Refine adding CSS files
2018-04-13 00:21:33 +09:00
Takeshi KOMIYA
1dd605971c
Merge pull request #4804 from tk0miya/add_SphinxDirective
Add SphinxDirective class
2018-04-08 23:30:19 +09:00
Takeshi KOMIYA
3afc72fba4 Rename add_stylesheet() to add_css_file() 2018-04-06 13:11:24 +09:00
Takeshi KOMIYA
47918f365e Merge branch 'master' into refactor_config 2018-04-02 10:47:47 +09:00
Takeshi KOMIYA
bc63dc8450 Rename Config.read() to Config.from_conf_py() 2018-04-01 20:07:45 +09:00
Takeshi KOMIYA
ab04a55dbf Add document for utility classes 2018-03-31 00:05:03 +09:00
Takeshi KOMIYA
962b6d459e Drop document.settings.gettext_compact 2018-03-30 13:06:11 +09:00
Takeshi KOMIYA
72a0896bd0 Merge branch 'master' into add_override_option 2018-03-29 22:03:05 +09:00
Takeshi KOMIYA
61828786a6 Deprecate app.override_domain() 2018-03-29 21:59:29 +09:00
Takeshi KOMIYA
a24601aa24 Deprecate Config.check_unicode() 2018-03-29 10:32:49 +09:00
Takeshi KOMIYA
febca7cf26 Merge branch 'master' into refactor_config 2018-03-28 01:01:03 +09:00
Takeshi KOMIYA
0f3fa689a4 Deprecate env._nitpick_ignore 2018-03-26 02:05:58 +09:00
Takeshi KOMIYA
78cbf96158 Deprecate Config.check_types() 2018-03-24 00:29:11 +09:00
Takeshi KOMIYA
ba83214386 Refactor: Add Config.read() as a constructor
To simplify Config.__init__() method, this separates conf.py parsing
feature to Config.read() method.
This allows to instantiate config object simply.
2018-03-23 23:40:28 +09:00
Takeshi KOMIYA
52ed9ef3a0 Closes #2157: helper function `warning()` for HTML themes is added 2018-03-19 00:18:10 +09:00
Takeshi KOMIYA
b3cbfc2bb5 Update deprecation list 2018-03-15 01:57:39 +09:00
Takeshi KOMIYA
e2f481c956 Merge branch '1.7' 2018-03-03 20:03:45 +09:00
Takeshi KOMIYA
bd898be3fc doc: Add deprecation list
So far, deprecated APIs are only listed as CHANGES entry.  But
they are not listed in one place.  In this change, I gathered them
to docs as a list.
As a side effect, it makes CHANGES entry simple.
2018-03-02 00:01:49 +09:00
Takeshi KOMIYA
b3e7609a80 Update docs 2018-02-25 23:44:38 +09:00
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