Pin Sphinx to <7.2 to hotfix breaking changes #542
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
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.
This works around sphinx-doc/sphinx#11608 and pradyunsg/furo#693.
All the repos I've seen have an unbound pin on Sphinx like
>=6.0, but a bound pin onqiskit-sphinx-themelike~=1.14.0. That means that when we release this hotfix, pip will merge the constraint from theirrequirements.txtof>=6.0with our theme's constraint of>=6.0,<7.2to use<7.2.This approach allows us to easily fix all the Ecosystem projects without needing to open a new PR for each of them. They will simply rebuild their docs and use the newest patch version of
qiskit-sphinx-theme.