1- Release 5.0.0 beta2 (in development )
2- ====================================
1+ Release 5.0.0 (released May 30, 2022 )
2+ =====================================
33
44Dependencies
55------------
66
7- Incompatible changes
8- --------------------
9-
10- * #10474: :confval:`language` does not accept ``None`` as it value. The default
11- value of ``language`` becomes to ``'en'`` now.
12-
13- Deprecated
14- ----------
15-
16- Features added
17- --------------
18-
19- Bugs fixed
20- ----------
21-
22- * #9575: autodoc: The annotation of return value should not be shown when
23- ``autodoc_typehints="description"``
24- * #9648: autodoc: ``*args`` and ``**kwargs`` entries are duplicated when
25- ``autodoc_typehints="description"``
26- * #8180: autodoc: Docstring metadata ignored for attributes
27- * #10443: epub: EPUB builder can't detect the mimetype of .webp file
28- * #10104: gettext: Duplicated locations are shown if 3rd party extension does
29- not provide correct information
30- * #10456: py domain: ``:meta:`` fields are displayed if docstring contains two
31- or more meta-field
32- * #9096: sphinx-build: the value of progress bar for paralle build is wrong
33- * #10110: sphinx-build: exit code is not changed when error is raised on
34- builder-finished event
7+ 5.0.0 b1
358
36- Testing
37- --------
38-
39- Release 5.0.0 beta1 (released May 09, 2022)
40- ===========================================
41-
42- Dependencies
43- ------------
449* #10164: Support `Docutils 0.18`_. Patch by Adam Turner.
4510
4611.. _Docutils 0.18: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-18-2021-10-26
4712
4813Incompatible changes
4914--------------------
5015
16+ 5.0.0 b1
17+
5118* #10031: autosummary: ``sphinx.ext.autosummary.import_by_name()`` now raises
5219 ``ImportExceptionGroup`` instead of ``ImportError`` when it failed to import
5320 target object. Please handle the exception if your extension uses the
@@ -66,9 +33,16 @@ Incompatible changes
6633* #10062: Change the default language to ``'en'`` if any language is not set in
6734 ``conf.py``
6835
36+ 5.0.0 final
37+
38+ * #10474: :confval:`language` does not accept ``None`` as it value. The default
39+ value of ``language`` becomes to ``'en'`` now.
40+
6941Deprecated
7042----------
7143
44+ 5.0.0 b1
45+
7246* #10028: jQuery and underscore.js will no longer be automatically injected into
7347 themes from Sphinx 6.0. If you develop a theme or extension that uses the
7448 ``jQuery``, ``$``, or ``$u`` global objects, you need to update your
@@ -101,6 +75,8 @@ Deprecated
10175Features added
10276--------------
10377
78+ 5.0.0 b1
79+
10480* #9075: autodoc: The default value of :confval:`autodoc_typehints_format` is
10581 changed to ``'smart'``. It will suppress the leading module names of
10682 typehints (ex. ``io.StringIO`` -> ``StringIO``).
@@ -125,6 +101,8 @@ Features added
125101Bugs fixed
126102----------
127103
104+ 5.0.0 b1
105+
128106* #10200: apidoc: Duplicated submodules are shown for modules having both .pyx
129107 and .so files
130108* #10279: autodoc: Default values for keyword only arguments in overloaded
@@ -154,8 +132,21 @@ Bugs fixed
154132* #10318: ``:prepend:`` option of :rst:dir:`literalinclude` directive does not
155133 work with ``:dedent:`` option
156134
157- Release 4.5.1 (in development)
158- ==============================
135+ 5.0.0 final
136+
137+ * #9575: autodoc: The annotation of return value should not be shown when
138+ ``autodoc_typehints="description"``
139+ * #9648: autodoc: ``*args`` and ``**kwargs`` entries are duplicated when
140+ ``autodoc_typehints="description"``
141+ * #8180: autodoc: Docstring metadata ignored for attributes
142+ * #10443: epub: EPUB builder can't detect the mimetype of .webp file
143+ * #10104: gettext: Duplicated locations are shown if 3rd party extension does
144+ not provide correct information
145+ * #10456: py domain: ``:meta:`` fields are displayed if docstring contains two
146+ or more meta-field
147+ * #9096: sphinx-build: the value of progress bar for paralle build is wrong
148+ * #10110: sphinx-build: exit code is not changed when error is raised on
149+ builder-finished event
159150
160151Release 4.5.0 (released Mar 28, 2022)
161152=====================================
0 commit comments