From 953002e6261bdd9314ee0a3314aae19479a88c7e Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 30 May 2022 01:19:20 +0900 Subject: [PATCH 1/3] Bump to 5.0.0 final --- CHANGES | 71 ++++++++++++++++++++-------------------------- sphinx/__init__.py | 6 ++-- 2 files changed, 34 insertions(+), 43 deletions(-) diff --git a/CHANGES b/CHANGES index 87b35403d..5594a23c3 100644 --- a/CHANGES +++ b/CHANGES @@ -1,46 +1,11 @@ -Release 5.0.0 beta2 (in development) -==================================== +Release 5.0.0 (released May 30, 2022) +===================================== Dependencies ------------ -Incompatible changes --------------------- +5.0.0 b1 -* #10474: :confval:`language` does not accept ``None`` as it value. The default - value of ``language`` becomes to ``'en'`` now. - -Deprecated ----------- - -Features added --------------- - -Bugs fixed ----------- - -* #9575: autodoc: The annotation of return value should not be shown when - ``autodoc_typehints="description"`` -* #9648: autodoc: ``*args`` and ``**kwargs`` entries are duplicated when - ``autodoc_typehints="description"`` -* #8180: autodoc: Docstring metadata ignored for attributes -* #10443: epub: EPUB builder can't detect the mimetype of .webp file -* #10104: gettext: Duplicated locations are shown if 3rd party extension does - not provide correct information -* #10456: py domain: ``:meta:`` fields are displayed if docstring contains two - or more meta-field -* #9096: sphinx-build: the value of progress bar for paralle build is wrong -* #10110: sphinx-build: exit code is not changed when error is raised on - builder-finished event - -Testing --------- - -Release 5.0.0 beta1 (released May 09, 2022) -=========================================== - -Dependencies ------------- * #10164: Support `Docutils 0.18`_. Patch by Adam Turner. .. _Docutils 0.18: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-18-2021-10-26 @@ -48,6 +13,8 @@ Dependencies Incompatible changes -------------------- +5.0.0 b1 + * #10031: autosummary: ``sphinx.ext.autosummary.import_by_name()`` now raises ``ImportExceptionGroup`` instead of ``ImportError`` when it failed to import target object. Please handle the exception if your extension uses the @@ -66,9 +33,16 @@ Incompatible changes * #10062: Change the default language to ``'en'`` if any language is not set in ``conf.py`` +5.0.0 final + +* #10474: :confval:`language` does not accept ``None`` as it value. The default + value of ``language`` becomes to ``'en'`` now. + Deprecated ---------- +5.0.0 b1 + * #10028: jQuery and underscore.js will no longer be automatically injected into themes from Sphinx 6.0. If you develop a theme or extension that uses the ``jQuery``, ``$``, or ``$u`` global objects, you need to update your @@ -101,6 +75,8 @@ Deprecated Features added -------------- +5.0.0 b1 + * #9075: autodoc: The default value of :confval:`autodoc_typehints_format` is changed to ``'smart'``. It will suppress the leading module names of typehints (ex. ``io.StringIO`` -> ``StringIO``). @@ -125,6 +101,8 @@ Features added Bugs fixed ---------- +5.0.0 b1 + * #10200: apidoc: Duplicated submodules are shown for modules having both .pyx and .so files * #10279: autodoc: Default values for keyword only arguments in overloaded @@ -154,8 +132,21 @@ Bugs fixed * #10318: ``:prepend:`` option of :rst:dir:`literalinclude` directive does not work with ``:dedent:`` option -Release 4.5.1 (in development) -============================== +5.0.0 final + +* #9575: autodoc: The annotation of return value should not be shown when + ``autodoc_typehints="description"`` +* #9648: autodoc: ``*args`` and ``**kwargs`` entries are duplicated when + ``autodoc_typehints="description"`` +* #8180: autodoc: Docstring metadata ignored for attributes +* #10443: epub: EPUB builder can't detect the mimetype of .webp file +* #10104: gettext: Duplicated locations are shown if 3rd party extension does + not provide correct information +* #10456: py domain: ``:meta:`` fields are displayed if docstring contains two + or more meta-field +* #9096: sphinx-build: the value of progress bar for paralle build is wrong +* #10110: sphinx-build: exit code is not changed when error is raised on + builder-finished event Release 4.5.0 (released Mar 28, 2022) ===================================== diff --git a/sphinx/__init__.py b/sphinx/__init__.py index c3ec8a2e3..0ff41378a 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -21,8 +21,8 @@ warnings.filterwarnings('ignore', "'U' mode is deprecated", warnings.filterwarnings('ignore', 'The frontend.Option class .*', DeprecationWarning, module='docutils.frontend') -__version__ = '5.0.0b1' -__released__ = '5.0.0b1' # used when Sphinx builds its own docs +__version__ = '5.0.0' +__released__ = '5.0.0' # used when Sphinx builds its own docs #: Version info for better programmatic use. #: @@ -32,7 +32,7 @@ __released__ = '5.0.0b1' # used when Sphinx builds its own docs #: #: .. versionadded:: 1.2 #: Before version 1.2, check the string ``sphinx.__version__``. -version_info = (5, 0, 0, 'beta', 1) +version_info = (5, 0, 0, 'final', 0) package_dir = path.abspath(path.dirname(__file__)) From cb19e218a245eb2e86c17c75403deaf5d81d18af Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 30 May 2022 01:20:38 +0900 Subject: [PATCH 2/3] Bump version --- CHANGES | 21 +++++++++++++++++++++ sphinx/__init__.py | 6 +++--- 2 files changed, 24 insertions(+), 3 deletions(-) diff --git a/CHANGES b/CHANGES index 5594a23c3..d962f8f89 100644 --- a/CHANGES +++ b/CHANGES @@ -1,3 +1,24 @@ +Release 5.0.1 (in development) +============================== + +Dependencies +------------ + +Incompatible changes +-------------------- + +Deprecated +---------- + +Features added +-------------- + +Bugs fixed +---------- + +Testing +-------- + Release 5.0.0 (released May 30, 2022) ===================================== diff --git a/sphinx/__init__.py b/sphinx/__init__.py index 0ff41378a..e947380bd 100644 --- a/sphinx/__init__.py +++ b/sphinx/__init__.py @@ -21,8 +21,8 @@ warnings.filterwarnings('ignore', "'U' mode is deprecated", warnings.filterwarnings('ignore', 'The frontend.Option class .*', DeprecationWarning, module='docutils.frontend') -__version__ = '5.0.0' -__released__ = '5.0.0' # used when Sphinx builds its own docs +__version__ = '5.0.1+' +__released__ = '5.0.1' # used when Sphinx builds its own docs #: Version info for better programmatic use. #: @@ -32,7 +32,7 @@ __released__ = '5.0.0' # used when Sphinx builds its own docs #: #: .. versionadded:: 1.2 #: Before version 1.2, check the string ``sphinx.__version__``. -version_info = (5, 0, 0, 'final', 0) +version_info = (5, 0, 1, 'beta', 0) package_dir = path.abspath(path.dirname(__file__)) From a904ab563a14ee5891551fdecf0d66d26774979f Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 30 May 2022 02:06:30 +0900 Subject: [PATCH 3/3] test: Change URL of testcase --- tests/roots/test-linkcheck/links.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/roots/test-linkcheck/links.txt b/tests/roots/test-linkcheck/links.txt index 4ff0c9f52..626f843f1 100644 --- a/tests/roots/test-linkcheck/links.txt +++ b/tests/roots/test-linkcheck/links.txt @@ -13,7 +13,7 @@ Some additional anchors to exercise ignore code * `Complete nonsense `_ * `Example valid local file `_ * `Example invalid local file `_ -* https://github.com/sphinx-doc/sphinx/blob/4.x/sphinx/__init__.py#L2 +* https://github.com/sphinx-doc/sphinx/blob/master/sphinx/__init__.py#L2 .. image:: https://www.google.com/image.png .. figure:: https://www.google.com/image2.png