build: remove version pin for Sphinx #5080
Merged
Conversation
This file contains 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
|
I don't think we should completely unpin the sphinx version but it does fix our CI test, clearly. If you could pin the version to a minimum of what fixes the issue, such as a 5.x, I'll merge. |
In cf69cad the Sphinx version was pinned to "<4.4.0". The issue at that time (a spurious warning) is described in: sphinx-doc/sphinx#10112 The problematic check was removed in Sphinx v4.5: https://www.sphinx-doc.org/en/master/changes.html#id334 The issue of spurious warnings was finally fixed in v5.x: sphinx-doc/sphinx#10137 Technically it would be suitable to add a negative version pin of Sphinx for "4.4". But that version is quite outdated and at least Debian never shipped Sphinx v4.4 in a stable release. We force sphinx to be at least v5 in order to fix an unrelated recent compatibility requirement of `sphinxcontrib.applehelp`.
sumpfralle
force-pushed
the
remove-sphinx-version-pin
branch
from
76e2785 to
3d308f9
Compare
|
You are right: the |
|
Cool, seems like this solves some problems. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In cf69cad the Sphinx version was pinned to "<4.4.0".
The issue at that time (a spurious warning) is described in:
sphinx-doc/sphinx#10112
The problematic check was removed in Sphinx v4.5:
https://www.sphinx-doc.org/en/master/changes.html#id334
The issue of spurious warnings was fixed in v5.x:
sphinx-doc/sphinx#10137
Technically it would be suitable to add negative version pin of Sphinx for "4.4".
But that version is quite outdated and at least Debian never shipped Sphinx v4.4 in a stable release.
This change fixes the current CI build failure, which is caused by an incompatibility of
sphinxcontrib-applehelpwith the older version of Sphinx.