@@ -18,247 +18,3 @@ Bugs fixed
1818
1919Testing
2020-------
21-
22- Release 9.0.4 (released Dec 04, 2025)
23- =====================================
24-
25- Bugs fixed
26- ----------
27-
28- * #14143: Fix spurious build warnings when translators reorder references
29- in strings, or use translated display text in references.
30- Patch by Matt Wang.
31-
32- Release 9.0.3 (released Dec 04, 2025)
33- =====================================
34-
35- Bugs fixed
36- ----------
37-
38- * #14142: autodoc: Restore some missing exports in :mod: `!sphinx.ext.autodoc `.
39- Patch by Adam Turner.
40-
41- Release 9.0.2 (released Dec 03, 2025)
42- =====================================
43-
44- Bugs fixed
45- ----------
46-
47- * #14142: autodoc: Restore :mod: `!sphinx.ext.autodoc.mock `.
48- Patch by Adam Turner.
49-
50- Release 9.0.1 (released Dec 01, 2025)
51- =====================================
52-
53- Bugs fixed
54- ----------
55-
56- * #13942: autodoc: Restore the mapping interface for options objects.
57- Patch by Adam Turner.
58- * #13942: autodoc: Deprecate the mapping interface for options objects.
59- Patch by Adam Turner.
60- * #13387: Update translations.
61-
62- Release 9.0.0 (released Nov 30, 2025)
63- =====================================
64-
65- Dependencies
66- ------------
67-
68- * #13786: Support `Docutils 0.22 `_. Patch by Adam Turner.
69-
70- .. _Docutils 0.22 : https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-22-2026-07-29
71-
72- Incompatible changes
73- --------------------
74-
75- * #13639: :py:meth: `!SphinxComponentRegistry.create_source_parser ` no longer
76- has an *app * parameter, instead taking *config * and *env *.
77- Patch by Adam Turner.
78- * #13679: Non-decodable characters in source files now raise an error.
79- Such bytes have been replaced with '?' along with logging a warning
80- since Sphinx 2.0.
81- Patch by Adam Turner.
82- * #13751, #14089: :mod: `sphinx.ext.autodoc ` has been substantially rewritten,
83- and there may be some incompatible changes in edge cases, especially when
84- extensions interact with autodoc internals.
85- The :confval: `autodoc_use_legacy_class_based ` option has been added to
86- use the legacy (pre-9.0) implementation of autodoc.
87- Patches by Adam Turner.
88- * #13355: Don't include escaped title content in the search index.
89- Patch by Will Lachance.
90-
91- Deprecated
92- ----------
93-
94- * 13627: Deprecate remaining public :py:attr: `!.app ` attributes,
95- including ``builder.app ``, ``env.app ``, ``events.app ``,
96- and ``SphinxTransform.app ``.
97- Patch by Adam Turner.
98- * #13637: Deprecate the :py:meth: `!set_application ` method
99- of :py:class: `~sphinx.parsers.Parser ` objects.
100- Patch by Adam Turner.
101- * #13644: Deprecate the :py:attr: `!Parser.config ` and :py:attr: `!env ` attributes.
102- Patch by Adam Turner.
103- * #13665: Deprecate support for non-UTF 8 source encodings,
104- scheduled for removal in Sphinx 10.
105- Patch by Adam Turner.
106- * #13682: Deprecate :py:mod: `!sphinx.io `.
107- Sphinx no longer uses the :py:mod: `!sphinx.io ` classes,
108- having replaced them with standard Python I/O.
109- The entire :py:mod: `!sphinx.io ` module will be removed in Sphinx 10.
110- Patch by Adam Turner.
111- * #13631: :func: `!sphinx.environment.adapters.toctree.global_toctree_for_doc `
112- and :meth: `!sphinx.environment.BuildEnvironment.get_and_resolve_doctree `
113- will require a *tags * keyword argument from Sphinx 11.
114- It may optionally be passed from Sphinx 9 onwards.
115- Patch by Adam Turner.
116-
117- Features added
118- --------------
119-
120- * #13332: Add :confval: `doctest_fail_fast ` option to exit after the first failed
121- test.
122- Patch by Till Hoffmann.
123- * #13439: linkcheck: Permit warning on every redirect with
124- ``linkcheck_allowed_redirects = {} ``.
125- Patch by Adam Turner and James Addison.
126- * #13497: Support C domain objects in the table of contents.
127- * #13500: LaTeX: add support for ``fontawesome6 `` package.
128- Patch by Jean-François B.
129- * #13509: autodoc: Detect :py:func: `typing_extensions.overload <typing.overload> `
130- and :py:func: `~typing.final ` decorators.
131- Patch by Spencer Brown.
132- * #13535: html search: Update to the latest version of Snowball (v3.0.1).
133- Patch by Adam Turner.
134- * #13647: LaTeX: allow more cases of table nesting.
135- Patch by Jean-François B.
136- * #13657: LaTeX: support CSS3 length units.
137- Patch by Jean-François B.
138- * #13684: intersphinx: Add a file-based cache for remote inventories.
139- The location of the cache directory must not be relied upon externally,
140- as it may change without notice or warning in future releases.
141- Patch by Adam Turner.
142- * #13805: LaTeX: add support for ``fontawesome7 `` package.
143- Patch by Jean-François B.
144- * #13508: autodoc: Initial support for :pep: `695 ` type aliases.
145- Patch by Martin Matouš, Jeremy Maitin-Shepard, and Adam Turner.
146- * #14023: Add the new :confval: `mathjax_config_path ` option
147- to load MathJax configuration from a file.
148- Patch by Randolf Scholz and Adam Turner.
149- * #14046: linkcheck: Add the :confval: `linkcheck_case_insensitive_urls ` option
150- to allow case-insensitive URL comparison for specific URL patterns.
151- This is useful for links to websites that normalise URL casing (e.g. GitHub)
152- or case-insensitive servers.
153- Patch by Fazeel Usmani and James Addison.
154- * #14075: autosummary: Provide more context in import exception stack traces.
155- Patch by Philipp A.
156- * #13468: Add config options to :mod: `sphinx.ext.duration `.
157- Patch by Erik Bedard and Adam Turner.
158- * #14022: Use MathJax v4 by default in the :mod: `sphinx.ext.mathjax ` extension,
159- from v3 previously.
160- To keep using an older version, set the :confval: `mathjax_path ` option.
161- Also add the new :confval: `mathjax4_config ` option to configure MathJax v4.
162- Note that MathJax v3 is mostly compatible with MathJax v4, so existing
163- :confval: `mathjax3_config ` settings should not need to change.
164- Patch by Matthias Geier.
165- * #14029: intersphinx: Fix error in format string interpolation.
166- Patch by Matthieu de Cibeins.
167- * #13894: Add ``source_code_parser `` type to :confval: `suppress_warnings `
168- for grouping issues related to the C and C++ parsers.
169- Patch by Valentin H.
170-
171- Bugs fixed
172- ----------
173-
174- * #13926: multiple py:type directives for the same canonical type no
175- longer result in spurious duplicate object description warnings.
176- Patch by Jeremy Maitin-Shepard.
177- * #1327: LaTeX: tables using longtable raise error if
178- :rst:dir: `tabularcolumns ` specifies automatic widths
179- (``L ``, ``R ``, ``C ``, or ``J ``).
180- Patch by Jean-François B.
181- * #3447: LaTeX: when assigning longtable class to table for PDF, it may render
182- "horizontally" and overflow in right margin.
183- Patch by Jean-François B.
184- * #8828: LaTeX: adding a footnote to a longtable cell causes table to occupy
185- full width.
186- Patch by Jean-François B.
187- * #11498: LaTeX: Table in cell fails to build if it has many rows.
188- Patch by Jean-François B.
189- * #11515: LaTeX: longtable does not allow nested table.
190- Patch by Jean-François B.
191- * #11973: LaTeX: links in table captions do not work in PDF.
192- Patch by Jean-François B.
193- * #12821: LaTeX: URLs/links in section titles should render in PDF.
194- Patch by Jean-François B.
195- * #13369: Correctly parse and cross-reference unpacked type annotations.
196- Patch by Alicia Garcia-Raboso.
197- * #13528: Add tilde ``~ `` prefix support for :rst:role: `py:deco `.
198- Patch by Shengyu Zhang and Adam Turner.
199- * #13597: LaTeX: table nested in a merged cell leads to invalid LaTeX mark-up
200- and PDF cannot be built.
201- Patch by Jean-François B.
202- * #13619: LaTeX: possible duplicated footnotes in PDF from object signatures
203- (typically if :confval: `latex_show_urls ` ``= 'footnote' ``).
204- Patch by Jean-François B.
205- * #13635: LaTeX: if a cell contains a table, row coloring is turned off for
206- the next table cells.
207- Patch by Jean-François B.
208- * #13685: gettext: Correctly ignore trailing backslashes.
209- Patch by Bénédikt Tran.
210- * #13712: intersphinx: Don't add "v" prefix to non-numeric versions.
211- Patch by Szymon Karpinski.
212- * #13688: HTML builder: Replace ``<em class="property"> `` with
213- ``<span class="property"> `` for attribute type annotations
214- to improve `semantic HTML structure
215- <https://html.spec.whatwg.org/multipage/text-level-semantics.html> `__.
216- Patch by Mark Ostroth.
217- * #13812 (discussion): LaTeX: long :rst:dir: `confval ` value does not wrap at
218- spaces in PDF.
219- Patch by Jean-François B.
220- * #10785: Autodoc: Allow type aliases defined in the project to be properly
221- cross-referenced when used as type annotations. This makes it possible
222- for objects documented as ``:py:data: `` to be hyperlinked in function signatures.
223- * #13858: doctest: doctest blocks are now correctly added to a group defined by the
224- configuration variable ``doctest_test_doctest_blocks ``.
225- * #13885: Coverage builder: Fix TypeError when warning about missing modules.
226- Patch by Damien Ayers.
227- * #13929: Duplicate equation label warnings now have a new warning
228- sub-type, ``ref.equation ``.
229- Patch by Jared Dillard.
230- * #13935: autoclass: parent class members no longer considered
231- directly defined in certain cases, depending on autodoc processing
232- order.
233- Patch by Jeremy Maitin-Shepard.
234- * #13939: LaTeX: page break can separate admonition title from contents.
235- Patch by Jean-François B.
236- * #14004: Fix :confval: `autodoc_type_aliases ` when they appear in PEP 604
237- union syntax (``Alias | Type ``).
238- Patch by Tamika Nomara.
239- * #14059: LaTeX: Footnotes cause pdflatex error with French language
240- (since late June 2025 upstream change to LaTeX ``babel-french ``).
241- Patch by Jean-François B.
242- * #13916: HTML Search: do not clear text fragments from the URL on page load.
243- Patch by Harmen Stoppels.
244- * #13944: autodoc: show traceback during import in human readable representation.
245- Patch by Florian Best.
246- * #14006: Support images with data URIs that aren't base64-encoded.
247- Patch by Shengyu Zhang and Adam Turner.
248- * #12797: Fix ``Some type variables (...) are not listed in Generic[...] ``
249- TypeError when inheriting from both Generic and autodoc mocked class.
250- Patch by Ikor Jefocur and Daniel Sperber.
251- * #13945: autodoc: Fix handling of undefined names in annotations by using
252- the ``FORWARDREF `` :mod: `annotationlib ` format.
253- Patch by Rui Pinheiro and Adam Turner.
254- * #14067: EPUB: unify path separators in manifest items to forward slashes;
255- resolve duplicates in the manifest on Windows.
256- Patch by Akihiro Takizawa.
257- * #13741: text builder: fix an infinite loop when processing CSV tables.
258- Patch by Bénédikt Tran.
259- * #13217: Remove extra parentheses from :rst:dir: `js:function ` arguments and errors.
260- Patch by Shengyu Zhang.
261-
262-
263- Testing
264- -------
0 commit comments