Skip to content

Commit 0d45b74

Browse files
authored
Bump Sphinx to 7.0.0 (#530)
readthedocs [is failing](https://app.readthedocs.org/projects/wfdb/builds/23195231/) with the following error: ``` Running Sphinx v4.5.0 loading translations [en]... done Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/wfdb/envs/latest/lib/python3.9/site-packages/sphinx/registry.py", line 438, in load_extension metadata = setup(app) File "/home/docs/checkouts/readthedocs.org/user_builds/wfdb/envs/latest/lib/python3.9/site-packages/sphinxcontrib/applehelp/__init__.py", line 230, in setup app.require_sphinx('5.0') File "/home/docs/checkouts/readthedocs.org/user_builds/wfdb/envs/latest/lib/python3.9/site-packages/sphinx/application.py", line 393, in require_sphinx raise VersionRequirementError(version) sphinx.errors.VersionRequirementError: 5.0 The above exception was the direct cause of the following exception: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/wfdb/envs/latest/lib/python3.9/site-packages/sphinx/cmd/build.py", line 272, in build_main app = Sphinx(args.sourcedir, args.confdir, args.outputdir, File "/home/docs/checkouts/readthedocs.org/user_builds/wfdb/envs/latest/lib/python3.9/site-packages/sphinx/application.py", line 219, in __init__ self.setup_extension(extension) File "/home/docs/checkouts/readthedocs.org/user_builds/wfdb/envs/latest/lib/python3.9/site-packages/sphinx/application.py", line 380, in setup_extension self.registry.load_extension(self, extname) File "/home/docs/checkouts/readthedocs.org/user_builds/wfdb/envs/latest/lib/python3.9/site-packages/sphinx/registry.py", line 441, in load_extension raise VersionRequirementError( sphinx.errors.VersionRequirementError: The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version. Sphinx version error: The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version. ``` This pull request fixes the build by: - bumping the version of Sphinx to 7.0.0 - fixing the language to "en" in the configuration file
2 parents 6e27547 + f7e6a3c commit 0d45b74

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

docs/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ def __getattr__(cls, name):
8282
#
8383
# This is also used if you do content translation via gettext catalogs.
8484
# Usually you set "language" from the command line for these cases.
85-
language = None
85+
language = "en"
8686

8787
# List of patterns, relative to source directory, that match files and
8888
# directories to ignore when looking for source files.

docs/requirements.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
numpydoc<1.6
2-
sphinx==4.5.0
3-
sphinx_rtd_theme==1.0.0
1+
numpydoc==1.7.0
2+
sphinx==7.0.0
3+
sphinx_rtd_theme==3.0.0
44
readthedocs-sphinx-search==0.3.2

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ dev = [
2525
"pytest-xdist >= 2.5.0",
2626
"pylint >= 2.13.7",
2727
"black >= 22.3.0",
28-
"sphinx >= 4.5.0",
28+
"sphinx >= 7.0.0",
2929
]
3030

3131
[project.urls]

0 commit comments

Comments
 (0)