Skip to content

Commit 8256092

Browse files
authored
Retarget to Sphinx 9.0 (#14093)
1 parent 4ba30e2 commit 8256092

File tree

14 files changed

+35
-35
lines changed

14 files changed

+35
-35
lines changed

CHANGES.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Release 8.3.0 (in development)
1+
Release 9.0.0 (in development)
22
==============================
33

44
Dependencies
@@ -18,7 +18,7 @@ Incompatible changes
1818
and there may be some incompatible changes in edge cases, especially when
1919
extensions interact with autodoc internals.
2020
The :confval:`autodoc_use_legacy_class_based` option has been added to
21-
use the legacy (pre-8.3) implementation of autodoc.
21+
use the legacy (pre-9.0) implementation of autodoc.
2222
Patches by Adam Turner.
2323

2424
Deprecated

doc/usage/configuration.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1157,9 +1157,9 @@ Options for source files
11571157
The recommended encoding is ``'utf-8-sig'``.
11581158

11591159
.. versionadded:: 0.5
1160-
.. deprecated:: 8.3
1160+
.. deprecated:: 9.0
11611161
Support for source encodings other than UTF-8 is deprecated.
1162-
Sphinx 10 will only support UTF-8 files.
1162+
Sphinx 11 will only support UTF-8 files.
11631163

11641164
.. confval:: source_suffix
11651165
:type: :code-py:`dict[str, str] | Sequence[str] | str`
@@ -3671,7 +3671,7 @@ and which failures and redirects it ignores.
36713671
36723672
.. versionadded:: 4.1
36733673

3674-
.. versionchanged:: 8.3
3674+
.. versionchanged:: 9.0
36753675
Setting :confval:`!linkcheck_allowed_redirects` to an empty dictionary
36763676
may now be used to warn on all redirects encountered
36773677
by the *linkcheck* builder.
@@ -3847,7 +3847,7 @@ and the number of workers to use.
38473847
.. note:: URI fragments (HTML anchors) are not affected by this option.
38483848
They are always checked with case-sensitive comparisons.
38493849

3850-
.. versionadded:: 8.3
3850+
.. versionadded:: 9.0
38513851

38523852
.. confval:: linkcheck_rate_limit_timeout
38533853
:type: :code-py:`int`

doc/usage/extensions/autodoc.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -971,7 +971,7 @@ Automatically document type aliases
971971

972972
.. rst:directive:: autotype
973973
974-
.. versionadded:: 8.3
974+
.. versionadded:: 9.0
975975

976976
Document a :pep:`695` type alias (the :keyword:`type` statement).
977977
By default, the directive only inserts the docstring of the alias itself:
@@ -1008,7 +1008,7 @@ There are also config values that you can set:
10081008
:default: :code-py:`False`
10091009

10101010
If true, autodoc will use the legacy class-based implementation.
1011-
This is the behaviour prior to Sphinx 8.3.
1011+
This is the behaviour prior to Sphinx 9.0.
10121012
It is based on the ``Documenter`` class hierarchy.
10131013

10141014
This setting is provided for backwards compatibility if your documentation

doc/usage/extensions/doctest.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -459,4 +459,4 @@ The doctest extension uses the following configuration values:
459459

460460
Exit when the first failure is encountered.
461461

462-
.. versionadded:: 8.3
462+
.. versionadded:: 9.0

doc/usage/extensions/math.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ Sphinx but is set to automatically include it from a third-party site.
346346

347347
__ https://docs.mathjax.org/en/latest/web/configuration.html#configuration
348348

349-
.. versionadded:: 8.3
349+
.. versionadded:: 9.0
350350

351351
:mod:`sphinxcontrib.jsmath` -- Render math via JavaScript
352352
---------------------------------------------------------

doc/usage/restructuredtext/directives.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -552,7 +552,7 @@ Describing changes between versions
552552
There must be no blank line between the directive head and the explanation;
553553
this is to make these blocks visually continuous in the markup.
554554

555-
.. version-changed:: 8.3
555+
.. version-changed:: 9.0
556556
The :rst:dir:`versionadded` directive was renamed to :rst:dir:`version-added`.
557557
The previous name is retained as an alias.
558558

@@ -570,7 +570,7 @@ Describing changes between versions
570570
Similar to :rst:dir:`version-added`, but describes when and what changed in
571571
the named feature in some way (new parameters, changed side effects, etc.).
572572

573-
.. version-changed:: 8.3
573+
.. version-changed:: 9.0
574574
The :rst:dir:`versionchanged` directive was renamed to :rst:dir:`version-changed`.
575575
The previous name is retained as an alias.
576576

@@ -590,7 +590,7 @@ Describing changes between versions
590590
A *brief* explanation can also be given,
591591
for example to tell the reader what to use instead.
592592

593-
.. version-changed:: 8.3
593+
.. version-changed:: 9.0
594594
The :rst:dir:`deprecated` directive was renamed to :rst:dir:`version-deprecated`.
595595
The previous name is retained as an alias
596596

@@ -611,7 +611,7 @@ Describing changes between versions
611611

612612
.. version-added:: 7.3
613613

614-
.. version-changed:: 8.3
614+
.. version-changed:: 9.0
615615
The :rst:dir:`versionremoved` directive was renamed to :rst:dir:`version-removed`.
616616
The previous name is retained as an alias.
617617

@@ -1492,7 +1492,7 @@ Check the :confval:`latex_table_style`.
14921492
complex contents such as multiple paragraphs, blockquotes, lists, literal
14931493
blocks, will render correctly to LaTeX output.
14941494

1495-
.. versionchanged:: 8.3.0
1495+
.. versionchanged:: 9.0
14961496
The partial support of the LaTeX builder for nesting a table in another
14971497
has been extended.
14981498
Formerly Sphinx would raise an error if ``longtable`` class was specified
@@ -1579,12 +1579,12 @@ Check the :confval:`latex_table_style`.
15791579
preamble, as in fact Sphinx uses ``T`` and sets it by default to be an
15801580
alias of ``J``.
15811581

1582-
.. versionchanged:: 8.3.0
1582+
.. versionchanged:: 9.0
15831583

15841584
Formerly, Sphinx did not use ``tabulary`` if the table had at least one
15851585
cell containing "problematic" elements such as lists, object descriptions,
15861586
blockquotes (etc...) because such contents are not out-of-the-box
1587-
compatible with ``tabulary``. At ``8.3.0`` a technique, which was already
1587+
compatible with ``tabulary``. At ``9.0`` a technique, which was already
15881588
in use for merged cells, was extended to such cases, and the sole
15891589
"problematic" contents are code-blocks and nested tables. So tables
15901590
containing (only) cells with multiple paragraphs, bullet or enumerated

sphinx/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
if TYPE_CHECKING:
1212
from typing import Final
1313

14-
__version__: Final = '8.3.0'
14+
__version__: Final = '9.0.0'
1515
__display_version__: Final = __version__ # used for command line version
1616

1717
#: Version info for better programmatic use.
@@ -22,7 +22,7 @@
2222
#:
2323
#: .. versionadded:: 1.2
2424
#: Before version 1.2, check the string ``sphinx.__version__``.
25-
version_info: Final = (8, 3, 0, 'beta', 0)
25+
version_info: Final = (9, 0, 0, 'beta', 0)
2626

2727
package_dir: Final = _StrPath(__file__).resolve().parent
2828
del _StrPath

sphinx/texinputs/sphinx.sty

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
% by the Sphinx LaTeX writer.
1010

1111
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
12-
\ProvidesPackage{sphinx}[2025/08/03 v8.3.0 Sphinx LaTeX package (sphinx-doc)]
12+
\ProvidesPackage{sphinx}[2025/08/03 v9.0.0 Sphinx LaTeX package (sphinx-doc)]
1313

1414
% provides \ltx@ifundefined
1515
% (many packages load ltxcmds: graphicx does for pdftex and lualatex but
@@ -872,8 +872,8 @@
872872
%
873873
% We let Sphinx use, listed in order of priority:
874874
% - a user-specified package via iconpackage key,
875-
% - fontawesome7 (supported since 8.3.0),
876-
% - fontawesome6 (supported since 8.3.0),
875+
% - fontawesome7 (supported since 9.0.0),
876+
% - fontawesome6 (supported since 9.0.0),
877877
% - fontawesome5,
878878
% - fontawesome,
879879
% - or nothing at all, and then icons are not drawn.
@@ -904,7 +904,7 @@
904904
}%
905905
% Unfortunately icon macro names are not the same across fontawesome,
906906
% fontawesome5, fontawesome6 and fontawesome7 LaTeX packages.
907-
% At 8.3.0 we refactor the
907+
% At 9.0.0 we refactor the
908908
% icon support code into something easier to maintain in future in case of a
909909
% fontawesome8, etc...
910910
%

sphinx/texinputs/sphinxlatexadmonitions.sty

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
%% NOTICES AND ADMONITIONS
22
%
33
% change this info string if making any custom modification
4-
\ProvidesPackage{sphinxlatexadmonitions}[2025/10/24 v8.3.0 admonitions]
4+
\ProvidesPackage{sphinxlatexadmonitions}[2025/10/24 v9.0.0 admonitions]
55

66
% Provides support for this output mark-up from Sphinx latex writer:
77
%
@@ -109,7 +109,7 @@
109109
% Code adapted from framed.sty's "snugshade" environment.
110110
% Nesting works (inner frames do not allow page breaks).
111111
%
112-
% At 8.3.0, avoid admonition title getting separated from contents at a
112+
% At 9.0, avoid admonition title getting separated from contents at a
113113
% page break.
114114
\newcommand\sphinxheavyboxneedspacecommand{\needspace{5\baselineskip}}
115115
\newenvironment{sphinxheavybox}{\par

sphinx/texinputs/sphinxlatexliterals.sty

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
%% LITERAL BLOCKS
22
%
33
% change this info string if making any custom modification
4-
\ProvidesPackage{sphinxlatexliterals}[2025/08/06 v8.3.0 code-blocks and parsed literals]
4+
\ProvidesPackage{sphinxlatexliterals}[2025/08/06 v9.0.0 code-blocks and parsed literals]
55

66
% Provides support for this output mark-up from Sphinx latex writer:
77
%

0 commit comments

Comments
 (0)