Skip to content

Commit 4a06aaf

Browse files
Require Sphinx 5+ (#461)
1 parent 3d4a583 commit 4a06aaf

File tree

5 files changed

+13
-11
lines changed

5 files changed

+13
-11
lines changed

.github/workflows/test.yml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,25 @@ jobs:
1616
strategy:
1717
matrix:
1818
os: [Ubuntu]
19-
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11-dev"]
19+
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
2020
sphinx-version:
2121
[
22-
"sphinx==4.2",
23-
"sphinx==4.5",
2422
"sphinx==5.0",
2523
"sphinx==5.3",
2624
"sphinx==6.0",
27-
"sphinx>6.0",
25+
"sphinx==6.2",
26+
"sphinx>=7.0",
2827
]
2928
exclude:
3029
- os: Ubuntu
3130
python-version: "3.7"
3231
sphinx-version: "sphinx==6.0"
33-
- os: Ubuntu
32+
- os: ubuntu
33+
python-version: "3.7"
34+
sphinx-version: "sphinx==6.2"
35+
- os: ubuntu
3436
python-version: "3.7"
35-
sphinx-version: "sphinx>6.0"
37+
sphinx-version: "sphinx>=7.0"
3638
steps:
3739
- uses: actions/checkout@v3
3840

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ docstrings formatted according to the NumPy documentation format.
1818
The extension also adds the code description directives
1919
``np:function``, ``np-c:function``, etc.
2020

21-
numpydoc requires Python 3.7+ and sphinx 4.2+.
21+
numpydoc requires Python 3.7+ and sphinx 5+.
2222

2323
For usage information, please refer to the `documentation
2424
<https://numpydoc.readthedocs.io/>`_.

doc/install.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Getting started
55
Installation
66
============
77

8-
This extension requires Python 3.7+, sphinx 4.2+ and is available from:
8+
This extension requires Python 3.7+, sphinx 5+ and is available from:
99

1010
* `numpydoc on PyPI <http://pypi.python.org/pypi/numpydoc>`_
1111
* `numpydoc on GitHub <https://github.com/numpy/numpydoc/>`_

numpydoc/numpydoc.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@
3030
from sphinx.util import logging
3131
from sphinx.errors import ExtensionError
3232

33-
if sphinx.__version__ < "4.2":
34-
raise RuntimeError("Sphinx 4.2 or newer is required")
33+
if sphinx.__version__ < "5":
34+
raise RuntimeError("Sphinx 5 or newer is required")
3535

3636
from .docscrape_sphinx import get_doc_object
3737
from .validate import validate, ERROR_MSGS

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ def read(fname):
5353
author_email="[email protected]",
5454
url="https://numpydoc.readthedocs.io",
5555
license="BSD",
56-
install_requires=["sphinx>=4.2", "Jinja2>=2.10"],
56+
install_requires=["sphinx>=5", "Jinja2>=2.10"],
5757
python_requires=">=3.7",
5858
extras_require={
5959
"testing": [

0 commit comments

Comments
 (0)