Skip to content

Commit cb7f5ed

Browse files
committed
doc: require sphinx 5
Fix #9836.
1 parent c72d202 commit cb7f5ed

File tree

5 files changed

+9
-13
lines changed

5 files changed

+9
-13
lines changed

doc/en/conf.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -162,11 +162,11 @@
162162

163163
_repo = "https://github.com/pytest-dev/pytest"
164164
extlinks = {
165-
"bpo": ("https://bugs.python.org/issue%s", "bpo-"),
166-
"pypi": ("https://pypi.org/project/%s/", ""),
167-
"issue": (f"{_repo}/issues/%s", "issue #"),
168-
"pull": (f"{_repo}/pull/%s", "pull request #"),
169-
"user": ("https://github.com/%s", "@"),
165+
"bpo": ("https://bugs.python.org/issue%s", "bpo-%s"),
166+
"pypi": ("https://pypi.org/project/%s/", "%s"),
167+
"issue": (f"{_repo}/issues/%s", "issue #%s"),
168+
"pull": (f"{_repo}/pull/%s", "pull request #%s"),
169+
"user": ("https://github.com/%s", "@%s"),
170170
}
171171

172172

@@ -419,8 +419,6 @@ def filter(self, record: logging.LogRecord) -> bool:
419419

420420

421421
def setup(app: "sphinx.application.Sphinx") -> None:
422-
# from sphinx.ext.autodoc import cut_lines
423-
# app.connect('autodoc-process-docstring', cut_lines(4, what=['module']))
424422
app.add_crossref_type(
425423
"fixture",
426424
"fixture",

doc/en/reference/customize.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ and can also be used to hold pytest configuration if they have a ``[pytest]`` se
9090
setup.cfg
9191
~~~~~~~~~
9292

93-
``setup.cfg`` files are general purpose configuration files, used originally by :doc:`distutils <distutils/configfile>`, and can also be used to hold pytest configuration
93+
``setup.cfg`` files are general purpose configuration files, used originally by :doc:`distutils <python:distutils/configfile>`, and can also be used to hold pytest configuration
9494
if they have a ``[tool:pytest]`` section.
9595

9696
.. code-block:: ini

doc/en/reference/reference.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -529,6 +529,7 @@ New code should avoid using :fixture:`testdir` in favor of :fixture:`pytester`.
529529

530530
.. autoclass:: pytest.Testdir()
531531
:members:
532+
:noindex: TimeoutExpired
532533

533534

534535
.. fixture:: recwarn

doc/en/requirements.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@ pallets-sphinx-themes
22
pluggy>=1.0
33
pygments-pytest>=2.2.0
44
sphinx-removed-in>=0.2.0
5-
sphinx>=3.1,<4
5+
sphinx>=5,<6
66
sphinxcontrib-trio
77
sphinxcontrib-svg2pdfconverter
8-
9-
# XXX: sphinx<4 is broken with latest jinja2
10-
jinja2<3.1

src/_pytest/python_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,7 @@ def approx(expected, rel=None, abs=None, nan_ok: bool = False) -> ApproxBase:
521521
"""Assert that two numbers (or two ordered sequences of numbers) are equal to each other
522522
within some tolerance.
523523
524-
Due to the :std:doc:`tutorial/floatingpoint`, numbers that we
524+
Due to the :doc:`python:tutorial/floatingpoint`, numbers that we
525525
would intuitively expect to be equal are not always so::
526526
527527
>>> 0.1 + 0.2 == 0.3

0 commit comments

Comments
 (0)