Skip to content

Commit 6f81aee

Browse files
authored
Merge branch 'master' into remove-extras
2 parents beedf71 + 7715d6f commit 6f81aee

File tree

377 files changed

+36750
-11983
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

377 files changed

+36750
-11983
lines changed

.gitattributes

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ tests/roots/test-pycode/cp_1251_coded.py dos
5151

5252
# Non UTF-8 encodings
5353
tests/roots/test-pycode/cp_1251_coded.py working-tree-encoding=windows-1251
54+
tests/roots/test-root/wrongenc.inc working-tree-encoding=latin-1
55+
tests/roots/test-warnings/wrongenc.inc working-tree-encoding=latin-1
5456

5557
# Generated files
5658
# https://github.com/github/linguist/blob/master/docs/overrides.md
@@ -62,4 +64,5 @@ tests/roots/test-pycode/cp_1251_coded.py working-tree-encoding=windows-1251
6264

6365
tests/js/fixtures/**/*.js generated
6466
sphinx/search/minified-js/*.js generated
67+
sphinx/search/_stopwords/ generated
6568
sphinx/themes/bizstyle/static/css3-mediaqueries.js generated

.github/workflows/lint.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,3 +123,21 @@ jobs:
123123
run: |
124124
python -m build .
125125
twine check dist/*
126+
127+
prettier:
128+
runs-on: ubuntu-latest
129+
130+
steps:
131+
- uses: actions/checkout@v4
132+
- name: Set up Node.js
133+
uses: actions/setup-node@v4
134+
with:
135+
node-version: "20"
136+
cache: "npm"
137+
- run: >
138+
npx prettier@3.5
139+
--check
140+
"sphinx/themes/**/*.js"
141+
"!sphinx/themes/bizstyle/static/css3-mediaqueries*.js"
142+
"tests/js/**/*.{js,mjs}"
143+
"!tests/js/fixtures/**"

.github/workflows/main.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ jobs:
4141
docutils:
4242
- "0.20"
4343
- "0.21"
44+
- "0.22"
4445
# include:
4546
# # test every supported Docutils version for the latest supported Python
4647
# - python: "3.13"
@@ -89,9 +90,11 @@ jobs:
8990
matrix:
9091
python:
9192
- "3.14"
93+
- "3.15"
9294
docutils:
9395
- "0.20"
9496
- "0.21"
97+
- "0.22"
9598

9699
steps:
97100
- uses: actions/checkout@v4
@@ -125,6 +128,7 @@ jobs:
125128
matrix:
126129
python:
127130
- "3.14"
131+
- "3.15"
128132

129133
steps:
130134
- uses: actions/checkout@v4

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
*.so
44
*.swp
55

6+
.auto/
67
.dir-locals.el
78
.cache/
89
.idea

.prettierrc.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# https://prettier.io/docs/options
2+
experimentalOperatorPosition = "start"

AUTHORS.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ Contributors
8383
* Louis Maddox -- better docstrings
8484
* Łukasz Langa -- partial support for autodoc
8585
* Marco Buttu -- doctest extension (pyversion option)
86+
* Mark Ostroth -- semantic HTML contributions
8687
* Martin Hans -- autodoc improvements
8788
* Martin Larralde -- additional napoleon admonitions
8889
* Martin Liška -- option directive and role improvements
@@ -102,6 +103,8 @@ Contributors
102103
* Slawek Figiel -- additional warning suppression
103104
* Stefan Seefeld -- toctree improvements
104105
* Stefan van der Walt -- autosummary extension
106+
* Steve Piercy -- documentation improvements
107+
* Szymon Karpinski -- intersphinx improvements
105108
* \T. Powers -- HTML output improvements
106109
* Taku Shimizu -- epub3 builder
107110
* Thomas Lamb -- linkcheck builder

CHANGES.rst

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,41 @@ Release 8.3.0 (in development)
44
Dependencies
55
------------
66

7+
* #13786: Support `Docutils 0.22`_. Patch by Adam Turner.
8+
9+
.. _Docutils 0.22: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-22-2026-07-29
10+
711
Incompatible changes
812
--------------------
913

14+
* #13639: :py:meth:`!SphinxComponentRegistry.create_source_parser` no longer
15+
has an *app* parameter, instead taking *config* and *env*.
16+
Patch by Adam Turner.
17+
1018
Deprecated
1119
----------
1220

21+
* 13627: Deprecate remaining public :py:attr:`!.app` attributes,
22+
including ``builder.app``, ``env.app``, ``events.app``,
23+
and ``SphinxTransform.`app``.
24+
Patch by Adam Turner.
25+
* #13637: Deprecate the :py:meth:`!set_application` method
26+
of :py:class:`~sphinx.parsers.Parser` objects.
27+
Patch by Adam Turner.
28+
* #13644: Deprecate the :py:attr:`!Parser.config` and :py:attr:`!env` attributes.
29+
Patch by Adam Turner.
30+
* #13665: Deprecate support for non-UTF 8 source encodings,
31+
scheduled for removal in Sphinx 10.
32+
Patch by Adam Turner.
33+
* #13679: Non-decodable characters in source files will raise an error in Sphinx 9.
34+
Currently, such bytes are replaced with '?' along with logging a warning.
35+
Patch by Adam Turner.
36+
* #13682: Deprecate :py:mod:`!sphinx.io`.
37+
Sphinx no longer uses the :py:mod:`!sphinx.io` classes,
38+
having replaced them with standard Python I/O.
39+
The entire :py:mod:`!sphinx.io` module will be removed in Sphinx 10.
40+
Patch by Adam Turner.
41+
1342
Features added
1443
--------------
1544

@@ -19,12 +48,64 @@ Features added
1948
* #13439: linkcheck: Permit warning on every redirect with
2049
``linkcheck_allowed_redirects = {}``.
2150
Patch by Adam Turner.
51+
* #13497: Support C domain objects in the table of contents.
52+
* #13500: LaTeX: add support for ``fontawesome6`` package.
53+
Patch by Jean-François B.
54+
* #13509: autodoc: Detect :py:func:`typing_extensions.overload <typing.overload>`
55+
and :py:func:`~typing.final` decorators.
56+
Patch by Spencer Brown.
57+
* #13535: html search: Update to the latest version of Snowball (v3.0.1).
58+
Patch by Adam Turner.
59+
* #13647: LaTeX: allow more cases of table nesting.
60+
Patch by Jean-François B.
61+
* #13684: intersphinx: Add a file-based cache for remote inventories.
62+
The location of the cache directory must not be relied upon externally,
63+
as it may change without notice or warning in future releases.
64+
Patch by Adam Turner.
2265

2366
Bugs fixed
2467
----------
2568

69+
* #1327: LaTeX: tables using longtable raise error if
70+
:rst:dir:`tabularcolumns` specifies automatic widths
71+
(``L``, ``R``, ``C``, or ``J``).
72+
Patch by Jean-François B.
73+
* #3447: LaTeX: when assigning longtable class to table for PDF, it may render
74+
"horizontally" and overflow in right margin.
75+
Patch by Jean-François B.
76+
* #8828: LaTeX: adding a footnote to a longtable cell causes table to occupy
77+
full width.
78+
Patch by Jean-François B.
79+
* #11498: LaTeX: Table in cell fails to build if it has many rows.
80+
Patch by Jean-François B.
81+
* #11515: LaTeX: longtable does not allow nested table.
82+
Patch by Jean-François B.
83+
* #11973: LaTeX: links in table captions do not work in PDF.
84+
Patch by Jean-François B.
85+
* #12821: LaTeX: URLs/links in section titles should render in PDF.
86+
Patch by Jean-François B.
2687
* #13369: Correctly parse and cross-reference unpacked type annotations.
2788
Patch by Alicia Garcia-Raboso.
89+
* #13528: Add tilde ``~`` prefix support for :rst:role:`py:deco`.
90+
Patch by Shengyu Zhang and Adam Turner.
91+
* #13597: LaTeX: table nested in a merged cell leads to invalid LaTeX mark-up
92+
and PDF cannot be built.
93+
Patch by Jean-François B.
94+
* #13619: LaTeX: possible duplicated footnotes in PDF from object signatures
95+
(typically if :confval:`latex_show_urls` ``= 'footnote'``).
96+
Patch by Jean-François B.
97+
* #13635: LaTeX: if a cell contains a table, row coloring is turned off for
98+
the next table cells.
99+
Patch by Jean-François B.
100+
* #13685: gettext: Correctly ignore trailing backslashes.
101+
Patch by Bénédikt Tran.
102+
* #13712: intersphinx: Don't add "v" prefix to non-numeric versions.
103+
Patch by Szymon Karpinski.
104+
* #13688: HTML builder: Replace ``<em class="property">`` with
105+
``<span class="property">`` for attribute type annotations
106+
to improve `semantic HTML structure
107+
<https://html.spec.whatwg.org/multipage/text-level-semantics.html>`__.
108+
Patch by Mark Ostroth.
28109

29110
Testing
30111
-------

doc/changes/5.3.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ Release 5.3.0 (released Oct 16, 2022)
88

99
* #10759: LaTeX: add :confval:`latex_table_style` and support the
1010
``'booktabs'``, ``'borderless'``, and ``'colorrows'`` styles.
11-
(thanks to Stefan Wiehler for initial pull requests #6666, #6671)
11+
(thanks to Stefan Wiehler for initial pull requests #6666, #6671).
12+
Using the ``'booktabs'`` style solves #6740 (Removing LaTeX
13+
column borders for automatic colspec).
14+
Patch by Jean-François B.
1215
* #10840: One can cross-reference including an option value like
1316
``:option:`--module=foobar```, ``:option:`--module[=foobar]```,
1417
or ``:option:`--module foobar```.

doc/changes/7.3.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Dependencies
8686

8787
* #11858: Increase the minimum supported version of Alabaster to 0.7.14.
8888
Patch by Adam Turner.
89-
* #11411: Support `Docutils 0.21`_. Patch by Adam Turner.
89+
* #12267: Support `Docutils 0.21`_. Patch by Adam Turner.
9090

9191
.. _Docutils 0.21: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-21-2024-04-09
9292
* #12012: Use ``types-docutils`` instead of ``docutils-stubs``.

doc/conf.py

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -297,14 +297,12 @@ def linkify_issues_in_changelog(
297297
) -> None:
298298
"""Linkify issue references like #123 in changelog to GitHub."""
299299
if docname == 'changes':
300+
linkified_changelog = re.sub(r'(?:PR)?#([0-9]+)\b', _linkify, source[0])
301+
source[0] = linkified_changelog
300302

301-
def linkify(match: re.Match[str]) -> str:
302-
url = 'https://github.com/sphinx-doc/sphinx/issues/' + match[1]
303-
return f'`{match[0]} <{url}>`_'
304-
305-
linkified_changelog = re.sub(r'(?:PR)?#([0-9]+)\b', linkify, source[0])
306303

307-
source[0] = linkified_changelog
304+
def _linkify(match: re.Match[str], /) -> str:
305+
return f'`{match[0]} <https://github.com/sphinx-doc/sphinx/issues/{match[1]}>`__'
308306

309307

310308
REDIRECT_TEMPLATE = """

0 commit comments

Comments
 (0)