Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Require sphinx>3 #385

Merged
merged 1 commit into from
Apr 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
matrix:
os: [Ubuntu]
python-version: ["3.7", "3.8", "3.9", "3.10"]
sphinx-version: ["sphinx==1.8.0", "sphinx==2.1", "sphinx>3.0"]
sphinx-version: ["sphinx==3.0", "sphinx==4.0", "sphinx>4.4"]
steps:
- uses: actions/checkout@v2

Expand All @@ -31,8 +31,7 @@ jobs:
python -m pip list

- name: Downgrade Jinja2 for sphinx<4
if: (${{ matrix.sphinx-version }} == 'sphinx==1.8.0') ||
(${{ matrix.sphinx-version }} == 'sphinx==2.1')
if: ${{ matrix.sphinx-version }} == 'sphinx<4.0.2'
run: python -m pip install jinja2==3.0.3

- name: Install
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ docstrings formatted according to the NumPy documentation format.
The extension also adds the code description directives
``np:function``, ``np-c:function``, etc.

numpydoc requires Python 3.7+ and sphinx 1.8+.
numpydoc requires Python 3.7+ and sphinx 3.0+.

For usage information, please refer to the `documentation
<https://numpydoc.readthedocs.io/>`_.
Expand Down
2 changes: 1 addition & 1 deletion doc/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Getting started
Installation
============

This extension requires Python 3.7+, sphinx 1.8+ and is available from:
This extension requires Python 3.7+, sphinx 3.0+ and is available from:

* `numpydoc on PyPI <http://pypi.python.org/pypi/numpydoc>`_
* `numpydoc on GitHub <https://github.com/numpy/numpydoc/>`_
Expand Down
2 changes: 1 addition & 1 deletion doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
numpy
matplotlib
pydata-sphinx-theme<=0.8.0
sphinx>2
sphinx>3
4 changes: 2 additions & 2 deletions numpydoc/numpydoc.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
from sphinx.util import logging
from sphinx.errors import ExtensionError

if sphinx.__version__ < '1.8':
raise RuntimeError("Sphinx 1.8 or newer is required")
if sphinx.__version__ < '3.0':
raise RuntimeError("Sphinx 3.0 or newer is required")

from .docscrape_sphinx import get_doc_object
from .validate import validate, ERROR_MSGS
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ def read(fname):
author_email="[email protected]",
url="https://numpydoc.readthedocs.io",
license="BSD",
install_requires=["sphinx>=1.8", 'Jinja2>=2.10'],
install_requires=["sphinx>=3.0", 'Jinja2>=2.10'],
python_requires=">=3.7",
extras_require={
"testing": [
Expand Down