Fix RTD build: update Ubuntu image and drop sphinx-hoverxref#34
Merged
Conversation
Read the Docs no longer accepts ubuntu-20.04 in build.os. Update to ubuntu-lts-latest and bump the Python toolchain to 3.14 to match CI. Remove sphinx-hoverxref, which is incompatible with Sphinx 9 and deprecated in favor of RTD's native Link previews addon. Co-authored-by: chrizzftd <chrizzFTD@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Read the Docs builds were failing for two reasons:
ubuntu-20.04was removed from RTD on 2026-06-01. The config still pinned that image, so builds failed at validation.sphinx-hoverxrefis incompatible with Sphinx 9 (_Optunpacking error onconfig-inited). Thedocsextra installs unpinned Sphinx, which currently resolves to 9.x.This PR mirrors the fix applied in naming#28.
Changes
.readthedocs.yml:ubuntu-20.04→ubuntu-lts-latest; Python3.13→3.14(aligns with CI Python-3.14 on CI #33)docs/source/conf.py: Removehoverxref.extensionand related configsetup.cfg: Removesphinx-hoverxreffrom thedocsextraNotes
namingdocs still work; only hover tooltips on those external links are removed.Test plan
python -m pip install -e ".[docs]"thenpython -m sphinx -W -b html docs/source docs/build