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

Bump Sphinx to 5.3.0 #10018

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

LevBernstein
Copy link

@LevBernstein LevBernstein commented Nov 19, 2024

Summary

Upgrade Sphinx to 5.3.0. This version is available in the Debian archive, but, unlike later versions, upgrading to it would not introduce significant breaking changes. This avoids the pitfalls of #9556. The only change I had to make was disabling table of contents entries for domain objects.

Sphinx 5.3.0 lacks the breaking changes to the gettext builder of the later versions, meaning builder.py doesn't need to be changed at all; it is still compatible with Python 3.8; it doesn't break the favicon; and it doesn't require bumping any of the other dependencies (sphinxcontrib-serializinghtml, etc.).

While #9938 mentions Sphinx 7.4.7 specifically, the issue at hand was that the version of Sphinx used here (4.4.0) was not available on the Debian archive; by switching to one that is, I think we can mark that issue as closed.

Checklist

  • If code changes were made then they have been tested.
    • I have updated the documentation to reflect the changes.
  • This PR fixes an issue.
  • This PR adds something new (e.g. new method or parameters).
  • This PR is a breaking change (e.g. methods or parameters removed/renamed)
  • This PR is not a code change (e.g. documentation, README, ...)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant