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

Update Sphinx to specifically use 5.0.2 #44

Merged
merged 1 commit into from
Feb 29, 2024

Conversation

SebastianPrehn
Copy link
Contributor

An attempt to fix the build failing, which gives the following error:

Running Sphinx v4.3.2
loading translations [en]... done

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/docker-migrid/envs/latest/lib/python3.10/site-packages/sphinx/registry.py", line 442, in load_extension
    metadata = setup(app)
  File "/home/docs/checkouts/readthedocs.org/user_builds/docker-migrid/envs/latest/lib/python3.10/site-packages/sphinxcontrib/applehelp/__init__.py", line 230, in setup
    app.require_sphinx('5.0')
  File "/home/docs/checkouts/readthedocs.org/user_builds/docker-migrid/envs/latest/lib/python3.10/site-packages/sphinx/application.py", line 407, 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/docker-migrid/envs/latest/lib/python3.10/site-packages/sphinx/cmd/build.py", line 276, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
  File "/home/docs/checkouts/readthedocs.org/user_builds/docker-migrid/envs/latest/lib/python3.10/site-packages/sphinx/application.py", line 233, in __init__
    self.setup_extension(extension)
  File "/home/docs/checkouts/readthedocs.org/user_builds/docker-migrid/envs/latest/lib/python3.10/site-packages/sphinx/application.py", line 394, in setup_extension
    self.registry.load_extension(self, extname)
  File "/home/docs/checkouts/readthedocs.org/user_builds/docker-migrid/envs/latest/lib/python3.10/site-packages/sphinx/registry.py", line 445, 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.

As mentioned in sphinx-doc/sphinx#11890, updating Sphinx to use 5.0.2 should satisfy applehelp without potentially introducing too many new errors from having a too new Sphinx.

Another potential fix is to let Sphinx be updated to its latest, but 5.0.2 seems a stable release to fix the relevant bug.

An attempt to fix the build failing
@jonasbardino jonasbardino merged commit c510f76 into ucphhpc:master Feb 29, 2024
@jonasbardino jonasbardino added the bug Something isn't working label Feb 29, 2024
@jonasbardino
Copy link
Contributor

Thanks for the proposed fix. Merged and hope it solves the problem 🤞

@jonasbardino jonasbardino self-assigned this Feb 29, 2024
@jonasbardino
Copy link
Contributor

docs built again with success ✔️ well done @SebastianPrehn :-)

@SebastianPrehn SebastianPrehn deleted the update-sphinx branch March 1, 2024 10:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants