Qiskit / qiskit_sphinx_theme

A Sphinx theme and documentation guidelines for Qiskit and Qiskit Ecosystem projects
https://qisk.it/docs-guide
Apache License 2.0
14 stars 29 forks source link

Pin Sphinx to <7.2 to hotfix breaking changes #542

Closed Eric-Arellano closed 1 year ago

Eric-Arellano commented 1 year ago

This works around https://github.com/sphinx-doc/sphinx/issues/11608 and https://github.com/pradyunsg/furo/discussions/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.