Skip to content

Commit 853b593

Browse files
committed
Retarget to Sphinx 9.0
1 parent 4ba30e2 commit 853b593

37 files changed

+131
-131
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/extdev/deprecated.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,33 +23,33 @@ The following is a list of deprecated interfaces.
2323
- Alternatives
2424

2525
* - ``sphinx.io`` (entire module)
26-
- 8.3
27-
- 10.0
26+
- 9.0
27+
- 11.0
2828
- ``docutils.io`` or standard Python I/O
2929

3030
* - ``sphinx.builders.Builder.app``
31-
- 8.3
32-
- 10.0
31+
- 9.0
32+
- 11.0
3333
- N/A
3434

3535
* - ``sphinx.environment.BuildEnvironment.app``
36-
- 8.3
37-
- 10.0
36+
- 9.0
37+
- 11.0
3838
- N/A
3939

4040
* - ``sphinx.transforms.Transform.app``
41-
- 8.3
42-
- 10.0
41+
- 9.0
42+
- 11.0
4343
- N/A
4444

4545
* - ``sphinx.transforms.post_transforms.SphinxPostTransform.app``
46-
- 8.3
47-
- 10.0
46+
- 9.0
47+
- 11.0
4848
- N/A
4949

5050
* - ``sphinx.events.EventManager.app``
51-
- 8.3
52-
- 10.0
51+
- 9.0
52+
- 11.0
5353
- N/A
5454

5555
* - ``sphinx.builders.singlehtml.SingleFileHTMLBuilder.fix_refuris``

doc/man/sphinx-build.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ Options
285285
The option is retained for compatibility, but may be removed at some
286286
later date.
287287

288-
.. xref RemovedInSphinx10Warning: deprecate this option in Sphinx 10
288+
.. xref RemovedInSphinx11Warning: deprecate this option in Sphinx 10
289289
or no earlier than 2026-01-01.
290290
291291
.. option:: -T, --show-traceback

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: 3 additions & 3 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
@@ -1335,7 +1335,7 @@ There are also config values that you can set:
13351335
which defaults to :code-py:`True` for backwards compatibility.
13361336
The default will change to :code-py:`False` in Sphinx 10.
13371337

1338-
.. xref RemovedInSphinx10Warning
1338+
.. xref RemovedInSphinx11Warning
13391339
13401340
.. confval:: autodoc_warningiserror
13411341
:type: :code-py:`bool`

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/builders/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -642,7 +642,7 @@ def read_doc(self, docname: str, *, _cache: bool = True) -> None:
642642
filename = env.doc2path(docname)
643643

644644
# set up error_handler for the target document
645-
# xref RemovedInSphinx90Warning
645+
# xref RemovedInSphinx10Warning
646646
error_handler = _UnicodeDecodeErrorHandler(docname)
647647
codecs.register_error('sphinx', error_handler) # type: ignore[arg-type]
648648

@@ -914,7 +914,7 @@ def __call__(self, error: UnicodeDecodeError) -> tuple[str, int]:
914914
__(
915915
"undecodable source characters, replacing with '?': '%s>>>%s<<<%s'. "
916916
'This will become an error in Sphinx 9.0.'
917-
# xref RemovedInSphinx90Warning
917+
# xref RemovedInSphinx10Warning
918918
),
919919
obj[line_start + 1 : error.start].decode(errors='backslashreplace'),
920920
obj[error.start : error.end].decode(errors='backslashreplace'),

0 commit comments

Comments
 (0)