Skip to content

Require Sphinx 5+ #461

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 8, 2023
Merged

Require Sphinx 5+ #461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 8 additions & 6 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,25 @@ jobs:
strategy:
matrix:
os: [Ubuntu]
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11-dev"]
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
sphinx-version:
[
"sphinx==4.2",
"sphinx==4.5",
"sphinx==5.0",
"sphinx==5.3",
"sphinx==6.0",
"sphinx>6.0",
"sphinx==6.2",
"sphinx>=7.0",
]
exclude:
- os: Ubuntu
python-version: "3.7"
sphinx-version: "sphinx==6.0"
- os: Ubuntu
- os: ubuntu
python-version: "3.7"
sphinx-version: "sphinx==6.2"
- os: ubuntu
python-version: "3.7"
sphinx-version: "sphinx>6.0"
sphinx-version: "sphinx>=7.0"
steps:
- uses: actions/checkout@v3

Expand Down
2 changes: 1 addition & 1 deletion README.rst
View file
Open in desktop
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 4.2+.
numpydoc requires Python 3.7+ and sphinx 5+.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably move to 3.8+ at some point, too


For usage information, please refer to the `documentation
<https://numpydoc.readthedocs.io/>`_.
Expand Down
2 changes: 1 addition & 1 deletion doc/install.rst
View file
Open in desktop
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 4.2+ and is available from:
This extension requires Python 3.7+, sphinx 5+ and is available from:

* `numpydoc on PyPI <http://pypi.python.org/pypi/numpydoc>`_
* `numpydoc on GitHub <https://github.com/numpy/numpydoc/>`_
Expand Down
4 changes: 2 additions & 2 deletions numpydoc/numpydoc.py
View file
Open in desktop
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__ < "4.2":
raise RuntimeError("Sphinx 4.2 or newer is required")
if sphinx.__version__ < "5":
raise RuntimeError("Sphinx 5 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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ def read(fname):
author_email="[email protected]",
url="https://numpydoc.readthedocs.io",
license="BSD",
install_requires=["sphinx>=4.2", "Jinja2>=2.10"],
install_requires=["sphinx>=5", "Jinja2>=2.10"],
python_requires=">=3.7",
extras_require={
"testing": [
Expand Down