Add back Furo to setup.py install_requires #330
Assignees
Milestone
Comments
Eric-Arellano
added a commit
that referenced
this issue
May 17, 2023
I didn't realize PyPI bans `install_requires` having a VCS (version control system) requirement. That's a good ban, but it broke the 1.12.0rc1 release. The workaround is to remove Furo from our `setup.py`. You don't need Furo installed to use our normal Pytorch theme, only to use the experiment `_qiskit_furo` theme. The docs still build even without Furo thanks to conditional imports: https://github.com/Qiskit/qiskit_sphinx_theme/blob/770d3b658a172d1b6e075e253901b8e141aac46e/qiskit_sphinx_theme/__init__.py#L63-L70 If you do want to use Furo, then you can still install it manually by e.g. adding it to your `requirements-dev.txt`. All our theme cares about is that Furo is in the virtual environment. It doesn't care how it got there. Once Furo has a stable release, we will move the requirement back to setup.py. Tracked by #330.
Eric-Arellano
added a commit
to Eric-Arellano/qiskit_sphinx_theme
that referenced
this issue
May 17, 2023
I didn't realize PyPI bans `install_requires` having a VCS (version control system) requirement. That's a good ban, but it broke the 1.12.0rc1 release. The workaround is to remove Furo from our `setup.py`. You don't need Furo installed to use our normal Pytorch theme, only to use the experiment `_qiskit_furo` theme. The docs still build even without Furo thanks to conditional imports: https://github.com/Qiskit/qiskit_sphinx_theme/blob/770d3b658a172d1b6e075e253901b8e141aac46e/qiskit_sphinx_theme/__init__.py#L63-L70 If you do want to use Furo, then you can still install it manually by e.g. adding it to your `requirements-dev.txt`. All our theme cares about is that Furo is in the virtual environment. It doesn't care how it got there. Once Furo has a stable release, we will move the requirement back to setup.py. Tracked by Qiskit#330.
Eric-Arellano
added a commit
that referenced
this issue
May 17, 2023
…331) (#332) I didn't realize PyPI bans `install_requires` having a VCS (version control system) requirement. That's a good ban, but it broke the 1.12.0rc1 release. The workaround is to remove Furo from our `setup.py`. You don't need Furo installed to use our normal Pytorch theme, only to use the experiment `_qiskit_furo` theme. The docs still build even without Furo thanks to conditional imports: https://github.com/Qiskit/qiskit_sphinx_theme/blob/770d3b658a172d1b6e075e253901b8e141aac46e/qiskit_sphinx_theme/__init__.py#L63-L70 If you do want to use Furo, then you can still install it manually by e.g. adding it to your `requirements-dev.txt`. All our theme cares about is that Furo is in the virtual environment. It doesn't care how it got there. Once Furo has a stable release, we will move the requirement back to setup.py. Tracked by #330.
Eric-Arellano
added a commit
that referenced
this issue
May 24, 2023
Closes #330. While we might not be ready to fully switch all production users to Furo in Theme 1.13, we at least will have made enough progress that it is ready for them to try it out. We want to make that setup easier. The main change that impacts us from the prior release (https://github.com/pradyunsg/furo/commits/2023.05.20) is that Furo now requires Sphinx 6.0+. Note that Sphinx 6 drops Python 3.7. Most Qiskit projects have already made this change, but not all yet. So we probably need to coordinate this PR with those projects.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Do this on the next stable release. See #331.
The text was updated successfully, but these errors were encountered: