1
- Release 5.0.0 beta2 (in development )
2
- ====================================
1
+ Release 5.0.0 (released May 30, 2022 )
2
+ =====================================
3
3
4
4
Dependencies
5
5
------------
6
6
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
35
8
36
- Testing
37
- --------
38
-
39
- Release 5.0.0 beta1 (released May 09, 2022)
40
- ===========================================
41
-
42
- Dependencies
43
- ------------
44
9
* #10164: Support `Docutils 0.18`_. Patch by Adam Turner.
45
10
46
11
.. _Docutils 0.18: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-18-2021-10-26
47
12
48
13
Incompatible changes
49
14
--------------------
50
15
16
+ 5.0.0 b1
17
+
51
18
* #10031: autosummary: ``sphinx.ext.autosummary.import_by_name()`` now raises
52
19
``ImportExceptionGroup`` instead of ``ImportError`` when it failed to import
53
20
target object. Please handle the exception if your extension uses the
@@ -66,9 +33,16 @@ Incompatible changes
66
33
* #10062: Change the default language to ``'en'`` if any language is not set in
67
34
``conf.py``
68
35
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
+
69
41
Deprecated
70
42
----------
71
43
44
+ 5.0.0 b1
45
+
72
46
* #10028: jQuery and underscore.js will no longer be automatically injected into
73
47
themes from Sphinx 6.0. If you develop a theme or extension that uses the
74
48
``jQuery``, ``$``, or ``$u`` global objects, you need to update your
@@ -101,6 +75,8 @@ Deprecated
101
75
Features added
102
76
--------------
103
77
78
+ 5.0.0 b1
79
+
104
80
* #9075: autodoc: The default value of :confval:`autodoc_typehints_format` is
105
81
changed to ``'smart'``. It will suppress the leading module names of
106
82
typehints (ex. ``io.StringIO`` -> ``StringIO``).
@@ -125,6 +101,8 @@ Features added
125
101
Bugs fixed
126
102
----------
127
103
104
+ 5.0.0 b1
105
+
128
106
* #10200: apidoc: Duplicated submodules are shown for modules having both .pyx
129
107
and .so files
130
108
* #10279: autodoc: Default values for keyword only arguments in overloaded
@@ -154,8 +132,21 @@ Bugs fixed
154
132
* #10318: ``:prepend:`` option of :rst:dir:`literalinclude` directive does not
155
133
work with ``:dedent:`` option
156
134
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
159
150
160
151
Release 4.5.0 (released Mar 28, 2022)
161
152
=====================================
0 commit comments