Merge branch '3.0.x' into 3.x

This commit is contained in:
Takeshi KOMIYA 2020-04-06 00:15:26 +09:00
commit 713bbf5caf

88
CHANGES
View File

@ -19,8 +19,8 @@ Bugs fixed
Testing Testing
-------- --------
Release 3.0.0 beta2 (in development) Release 3.0.1 (in development)
==================================== ==============================
Dependencies Dependencies
------------ ------------
@ -34,38 +34,20 @@ Deprecated
Features added Features added
-------------- --------------
* Added ``ObjectDescription.transform_content()``.
Bugs fixed Bugs fixed
---------- ----------
* #7364: autosummary: crashed when :confval:`autosummary_generate` is False
* #7370: autosummary: raises UnboundLocalError when unknown module given
* #7367: C++, alternate operator spellings are now supported.
* C, alternate operator spellings are now supported.
* #7368: C++, comma operator in expressions, pack expansion in template
argument lists, and more comprehensive error messages in some cases.
* C, C++, fix crash and wrong duplicate warnings related to anon symbols.
* #6477: Escape first "!" in a cross reference linking no longer possible
* #7219: py domain: The index entry generated by ``py:function`` directive is
different with one from ``index`` directive with "builtin" type
* #7301: capital characters are not allowed for node_id
* #7301: epub: duplicated node_ids are generated
* #6564: html: a width of table was ignored on HTML builder
* #7401: Incorrect argument is passed for :event:`env-get-outdated` handlers
* #7355: autodoc: a signature of cython-function is not recognized well
* #7409: intersphinx: ValueError is raised when an extension sets up
:confval:`intersphinx_mapping` on :event:`config-inited` event
Testing Testing
-------- --------
Release 3.0.0 beta1 (released Mar 23, 2020) Release 3.0.0 (released Apr 06, 2020)
=========================================== =====================================
Dependencies Dependencies
------------ ------------
3.0.0b1
* LaTeX: drop dependency on :program:`extractbb` for image inclusion in * LaTeX: drop dependency on :program:`extractbb` for image inclusion in
Japanese documents as ``.xbb`` files are unneeded by :program:`dvipdfmx` Japanese documents as ``.xbb`` files are unneeded by :program:`dvipdfmx`
since TeXLive2015 (refs: #6189) since TeXLive2015 (refs: #6189)
@ -74,6 +56,8 @@ Dependencies
Incompatible changes Incompatible changes
-------------------- --------------------
3.0.0b1
* Drop features and APIs deprecated in 1.8.x * Drop features and APIs deprecated in 1.8.x
* #247: autosummary: stub files are overwritten automatically by default. see * #247: autosummary: stub files are overwritten automatically by default. see
:confval:`autosummary_generate_overwrite` to change the behavior :confval:`autosummary_generate_overwrite` to change the behavior
@ -108,9 +92,15 @@ Incompatible changes
single backslashes as default. A new configuration value single backslashes as default. A new configuration value
:confval:`strip_signature_backslash` can be used by users to reenable it. :confval:`strip_signature_backslash` can be used by users to reenable it.
3.0.0 final
* #7222: ``sphinx.util.inspect.unwrap()`` is renamed to ``unwrap_all()``
Deprecated Deprecated
---------- ----------
3.0.0b1
* ``desc_signature['first']`` * ``desc_signature['first']``
* ``sphinx.directives.DescDirective`` * ``sphinx.directives.DescDirective``
* ``sphinx.domains.std.StandardDomain.add_object()`` * ``sphinx.domains.std.StandardDomain.add_object()``
@ -126,6 +116,8 @@ Deprecated
Features added Features added
-------------- --------------
3.0.0b1
* #247: autosummary: Add :confval:`autosummary_generate_overwrite` to overwrite * #247: autosummary: Add :confval:`autosummary_generate_overwrite` to overwrite
old stub file old stub file
* #5923: autodoc: ``:inherited-members:`` option takes a name of anchestor class * #5923: autodoc: ``:inherited-members:`` option takes a name of anchestor class
@ -181,9 +173,15 @@ Features added
* #7324: sphinx-build: Emit a warning if multiple files having different file * #7324: sphinx-build: Emit a warning if multiple files having different file
extensions for same document found extensions for same document found
3.0.0 final
* Added ``ObjectDescription.transform_content()``.
Bugs fixed Bugs fixed
---------- ----------
3.0.0b1
* C++, fix cross reference lookup in certain cases involving * C++, fix cross reference lookup in certain cases involving
function overloads. function overloads.
* #5078: C++, fix cross reference lookup when a directive contains multiple * #5078: C++, fix cross reference lookup when a directive contains multiple
@ -211,31 +209,27 @@ Bugs fixed
* #7290: sphinx-build: Ignore bdb.BdbQuit when handling exceptions * #7290: sphinx-build: Ignore bdb.BdbQuit when handling exceptions
* #6240: napoleon: Attributes and Methods sections ignore :noindex: option * #6240: napoleon: Attributes and Methods sections ignore :noindex: option
Release 2.4.5 (in development) 3.0.0 final
==============================
Dependencies * #7364: autosummary: crashed when :confval:`autosummary_generate` is False
------------ * #7370: autosummary: raises UnboundLocalError when unknown module given
* #7367: C++, alternate operator spellings are now supported.
Incompatible changes * C, alternate operator spellings are now supported.
-------------------- * #7368: C++, comma operator in expressions, pack expansion in template
argument lists, and more comprehensive error messages in some cases.
* #7222: ``sphinx.util.inspect.unwrap()`` is renamed to ``unwrap_all()`` * C, C++, fix crash and wrong duplicate warnings related to anon symbols.
* #6477: Escape first "!" in a cross reference linking no longer possible
Deprecated * #7219: py domain: The index entry generated by ``py:function`` directive is
---------- different with one from ``index`` directive with "builtin" type
* #7301: capital characters are not allowed for node_id
Features added * #7301: epub: duplicated node_ids are generated
-------------- * #6564: html: a width of table was ignored on HTML builder
* #7401: Incorrect argument is passed for :event:`env-get-outdated` handlers
Bugs fixed * #7355: autodoc: a signature of cython-function is not recognized well
----------
* #7343: Sphinx builds has been slower since 2.4.0 on debug mode
* #7222: autodoc: ``__wrapped__`` functions are not documented correctly * #7222: autodoc: ``__wrapped__`` functions are not documented correctly
* #7409: intersphinx: ValueError is raised when an extension sets up
Testing :confval:`intersphinx_mapping` on :event:`config-inited` event
-------- * #7343: Sphinx builds has been slower since 2.4.0 on debug mode
Release 2.4.4 (released Mar 05, 2020) Release 2.4.4 (released Mar 05, 2020)
===================================== =====================================