Skip to content

Commit 65b014a

Browse files
committed
docs: support Sphinx>=3.1 and require it
Previously was restricted to >=1.8.2,<2.1, but newer versions have some nice improvements I'd like to be able to use in upcoming changes. Changelog: https://www.sphinx-doc.org/en/master/changes.html#release-3-1-0-released-jun-08-2020 There are two issues that came up: 1. `highlightlang` is deprecated for `highlight`. 2. Doesn't like having two `automethod` generated for the same `Metafunc.parametrize` method. Gives this warning: `pytest/doc/en/reference.rst:846: WARNING: duplicate object description of _pytest.python.Metafunc.parametrize, other instance in reference, use :noindex: for one of them` To work around this I make `pytest.mark.parametrize` link to `Metafunc.parametrize` instead of repeating it.
1 parent 358150c commit 65b014a

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

doc/en/goodpractices.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. highlightlang:: python
1+
.. highlight:: python
22
.. _`goodpractices`:
33

44
Good Integration Practices

doc/en/reference.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ pytest.mark.parametrize
138138

139139
**Tutorial**: :doc:`parametrize`.
140140

141-
.. automethod:: _pytest.python.Metafunc.parametrize
141+
This mark has the same signature as :py:meth:`_pytest.python.Metafunc.parametrize`; see there.
142142

143143

144144
.. _`pytest.mark.skip ref`:

doc/en/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
pallets-sphinx-themes
22
pygments-pytest>=1.1.0
33
sphinx-removed-in>=0.2.0
4-
sphinx>=1.8.2,<2.1
4+
sphinx>=3.1,<4
55
sphinxcontrib-trio

0 commit comments

Comments
 (0)