Skip to content

Commit 8e24c46

Browse files
Pin Sphinx to <7.2 to hotfix breaking changes (#540)
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 on `qiskit-sphinx-theme` like `~=1.14.0`. That means that when we release this hotfix, pip will merge the constraint from their `requirements.txt` of `>=6.0` with our theme's constraint of `>=6.0,<7.2` to 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`.
1 parent 0c5935c commit 8e24c46

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

pyproject.toml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ classifiers = [
2424

2525
dependencies = [
2626
"docutils",
27-
# Keep in sync with Furo's constraint.
28-
"sphinx>=6.0",
27+
# Keep in sync with Furo's constraint. <7.2 is to work
28+
# around https://github.com/sphinx-doc/sphinx/issues/11608
29+
# and https://github.com/pradyunsg/furo/discussions/693.
30+
"sphinx>=6.0,<7.2",
2931
# Remove jQuery once we get rid of the Pytorch theme.
3032
"sphinxcontrib-jquery",
3133
# See CONTRIBUTING.md for how to upgrade Furo.

0 commit comments

Comments
 (0)