From 901e693f8fe6e972b5232fc192cb78628a366a72 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 6 Apr 2020 00:05:36 +0900 Subject: [PATCH 1/4] Merge 2.4.5 CHANGES entries into 3.0.0 --- CHANGES | 30 ++++-------------------------- 1 file changed, 4 insertions(+), 26 deletions(-) diff --git a/CHANGES b/CHANGES index 53b2b57ca..b39a72c6c 100644 --- a/CHANGES +++ b/CHANGES @@ -7,6 +7,8 @@ Dependencies Incompatible changes -------------------- +* #7222: ``sphinx.util.inspect.unwrap()`` is renamed to ``unwrap_all()`` + Deprecated ---------- @@ -33,8 +35,10 @@ Bugs fixed * #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 +* #7222: autodoc: ``__wrapped__`` functions are not documented correctly * #7409: intersphinx: ValueError is raised when an extension sets up :confval:`intersphinx_mapping` on :event:`config-inited` event +* #7343: Sphinx builds has been slower since 2.4.0 on debug mode Testing -------- @@ -190,32 +194,6 @@ Bugs fixed * #7290: sphinx-build: Ignore bdb.BdbQuit when handling exceptions * #6240: napoleon: Attributes and Methods sections ignore :noindex: option -Release 2.4.5 (in development) -============================== - -Dependencies ------------- - -Incompatible changes --------------------- - -* #7222: ``sphinx.util.inspect.unwrap()`` is renamed to ``unwrap_all()`` - -Deprecated ----------- - -Features added --------------- - -Bugs fixed ----------- - -* #7343: Sphinx builds has been slower since 2.4.0 on debug mode -* #7222: autodoc: ``__wrapped__`` functions are not documented correctly - -Testing --------- - Release 2.4.4 (released Mar 05, 2020) ===================================== From 9a4ab5403e56ca9db433afa1512f01a2c86913a5 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 6 Apr 2020 00:08:08 +0900 Subject: [PATCH 2/4] Merge 3.0.0b2 CHANGES entries into 3.0.0 --- CHANGES | 87 +++++++++++++++++++++++++++------------------------------ 1 file changed, 41 insertions(+), 46 deletions(-) diff --git a/CHANGES b/CHANGES index b39a72c6c..38599d5f7 100644 --- a/CHANGES +++ b/CHANGES @@ -1,53 +1,10 @@ -Release 3.0.0 beta2 (in development) -==================================== +Release 3.0.0 (in development) +============================== Dependencies ------------ -Incompatible changes --------------------- - -* #7222: ``sphinx.util.inspect.unwrap()`` is renamed to ``unwrap_all()`` - -Deprecated ----------- - -Features added --------------- - -* Added ``ObjectDescription.transform_content()``. - -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 -* #7222: autodoc: ``__wrapped__`` functions are not documented correctly -* #7409: intersphinx: ValueError is raised when an extension sets up - :confval:`intersphinx_mapping` on :event:`config-inited` event -* #7343: Sphinx builds has been slower since 2.4.0 on debug mode - -Testing --------- - -Release 3.0.0 beta1 (released Mar 23, 2020) -=========================================== - -Dependencies ------------- +3.0.0b1 * LaTeX: drop dependency on :program:`extractbb` for image inclusion in Japanese documents as ``.xbb`` files are unneeded by :program:`dvipdfmx` @@ -57,6 +14,8 @@ Dependencies Incompatible changes -------------------- +3.0.0b1 + * Drop features and APIs deprecated in 1.8.x * #247: autosummary: stub files are overwritten automatically by default. see :confval:`autosummary_generate_overwrite` to change the behavior @@ -91,9 +50,15 @@ Incompatible changes single backslashes as default. A new configuration value :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 ---------- +3.0.0b1 + * ``desc_signature['first']`` * ``sphinx.directives.DescDirective`` * ``sphinx.domains.std.StandardDomain.add_object()`` @@ -109,6 +74,8 @@ Deprecated Features added -------------- +3.0.0b1 + * #247: autosummary: Add :confval:`autosummary_generate_overwrite` to overwrite old stub file * #5923: autodoc: ``:inherited-members:`` option takes a name of anchestor class @@ -164,9 +131,15 @@ Features added * #7324: sphinx-build: Emit a warning if multiple files having different file extensions for same document found +3.0.0 final + +* Added ``ObjectDescription.transform_content()``. + Bugs fixed ---------- +3.0.0b1 + * C++, fix cross reference lookup in certain cases involving function overloads. * #5078: C++, fix cross reference lookup when a directive contains multiple @@ -194,6 +167,28 @@ Bugs fixed * #7290: sphinx-build: Ignore bdb.BdbQuit when handling exceptions * #6240: napoleon: Attributes and Methods sections ignore :noindex: option +3.0.0 final + +* #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 +* #7222: autodoc: ``__wrapped__`` functions are not documented correctly +* #7409: intersphinx: ValueError is raised when an extension sets up + :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) ===================================== From 8178597970186365de88a44bb18c83f978b5ba05 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 6 Apr 2020 00:11:34 +0900 Subject: [PATCH 3/4] Bump to 3.0.0 final --- CHANGES | 4 ++-- sphinx/__init__.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGES b/CHANGES index 38599d5f7..382485d85 100644 --- a/CHANGES +++ b/CHANGES @@ -1,5 +1,5 @@ -Release 3.0.0 (in development) -============================== +Release 3.0.0 (released Apr 06, 2020) +===================================== Dependencies ------------ diff --git a/sphinx/__init__.py b/sphinx/__init__.py index a22735309..e98dd28d1 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -32,7 +32,7 @@ if 'PYTHONWARNINGS' not in os.environ: warnings.filterwarnings('ignore', "'U' mode is deprecated", DeprecationWarning, module='docutils.io') -__version__ = '3.0.0+' +__version__ = '3.0.0' __released__ = '3.0.0' # used when Sphinx builds its own docs #: Version info for better programmatic use. @@ -43,7 +43,7 @@ __released__ = '3.0.0' # used when Sphinx builds its own docs #: #: .. versionadded:: 1.2 #: Before version 1.2, check the string ``sphinx.__version__``. -version_info = (3, 0, 0, 'beta', 2) +version_info = (3, 0, 0, 'final', 0) package_dir = path.abspath(path.dirname(__file__)) From 2def1fc70410bafa1120e69c6cbf9c4ebe819515 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 6 Apr 2020 00:14:06 +0900 Subject: [PATCH 4/4] Bump version --- CHANGES | 21 +++++++++++++++++++++ sphinx/__init__.py | 6 +++--- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/CHANGES b/CHANGES index 382485d85..212f4571f 100644 --- a/CHANGES +++ b/CHANGES @@ -1,3 +1,24 @@ +Release 3.0.1 (in development) +============================== + +Dependencies +------------ + +Incompatible changes +-------------------- + +Deprecated +---------- + +Features added +-------------- + +Bugs fixed +---------- + +Testing +-------- + Release 3.0.0 (released Apr 06, 2020) ===================================== diff --git a/sphinx/__init__.py b/sphinx/__init__.py index e98dd28d1..e2c489279 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -32,8 +32,8 @@ if 'PYTHONWARNINGS' not in os.environ: warnings.filterwarnings('ignore', "'U' mode is deprecated", DeprecationWarning, module='docutils.io') -__version__ = '3.0.0' -__released__ = '3.0.0' # used when Sphinx builds its own docs +__version__ = '3.0.1+' +__released__ = '3.0.1' # used when Sphinx builds its own docs #: Version info for better programmatic use. #: @@ -43,7 +43,7 @@ __released__ = '3.0.0' # used when Sphinx builds its own docs #: #: .. versionadded:: 1.2 #: Before version 1.2, check the string ``sphinx.__version__``. -version_info = (3, 0, 0, 'final', 0) +version_info = (3, 0, 1, 'beta', 0) package_dir = path.abspath(path.dirname(__file__))