Skip to content

Commit eb22997

Browse files
Require sphinx>3 (#385)
1 parent d7d937e commit eb22997

File tree

6 files changed

+8
-9
lines changed

6 files changed

+8
-9
lines changed

.github/workflows/test.yml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
matrix:
1414
os: [Ubuntu]
1515
python-version: ["3.7", "3.8", "3.9", "3.10"]
16-
sphinx-version: ["sphinx==1.8.0", "sphinx==2.1", "sphinx>3.0"]
16+
sphinx-version: ["sphinx==3.0", "sphinx==4.0", "sphinx>4.4"]
1717
steps:
1818
- uses: actions/checkout@v2
1919

@@ -31,8 +31,7 @@ jobs:
3131
python -m pip list
3232
3333
- name: Downgrade Jinja2 for sphinx<4
34-
if: (${{ matrix.sphinx-version }} == 'sphinx==1.8.0') ||
35-
(${{ matrix.sphinx-version }} == 'sphinx==2.1')
34+
if: ${{ matrix.sphinx-version }} == 'sphinx<4.0.2'
3635
run: python -m pip install jinja2==3.0.3
3736

3837
- name: Install

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 1.8+.
21+
numpydoc requires Python 3.7+ and sphinx 3.0+.
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 1.8+ and is available from:
8+
This extension requires Python 3.7+, sphinx 3.0+ and is available from:
99

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

doc/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
numpy
22
matplotlib
33
pydata-sphinx-theme<=0.8.0
4-
sphinx>2
4+
sphinx>3

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__ < '1.8':
34-
raise RuntimeError("Sphinx 1.8 or newer is required")
33+
if sphinx.__version__ < '3.0':
34+
raise RuntimeError("Sphinx 3.0 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
@@ -51,7 +51,7 @@ def read(fname):
5151
author_email="[email protected]",
5252
url="https://numpydoc.readthedocs.io",
5353
license="BSD",
54-
install_requires=["sphinx>=1.8", 'Jinja2>=2.10'],
54+
install_requires=["sphinx>=3.0", 'Jinja2>=2.10'],
5555
python_requires=">=3.7",
5656
extras_require={
5757
"testing": [

0 commit comments

Comments
 (0)