Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Furo to install_requires and bump Sphinx requirement to 6.0+ #339

Merged
merged 1 commit into from
May 24, 2023

Conversation

Eric-Arellano
Copy link
Collaborator

@Eric-Arellano Eric-Arellano commented May 23, 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.

@Eric-Arellano Eric-Arellano changed the title Add Furo to install_requires and bump Sphinx requirement to 6.0+ [on hold] Add Furo to install_requires and bump Sphinx requirement to 6.0+ May 23, 2023
@Eric-Arellano Eric-Arellano marked this pull request as draft May 23, 2023 13:26
@Eric-Arellano
Copy link
Collaborator Author

I realized that Sphinx 6 drops Python 3.7 support, which may break some projects' CI when they upgrade to Theme 1.13. I will bring this up at today's Qiskit Dev Meeting. On Hold for now.

@Eric-Arellano Eric-Arellano added the on hold On hold for now label May 23, 2023
@Eric-Arellano Eric-Arellano changed the title [on hold] Add Furo to install_requires and bump Sphinx requirement to 6.0+ Add Furo to install_requires and bump Sphinx requirement to 6.0+ May 23, 2023
@Eric-Arellano Eric-Arellano marked this pull request as ready for review May 23, 2023 18:19
@Eric-Arellano
Copy link
Collaborator Author

We realized in the Qiskit Dev meeting that this is safe to land. Even if some projects want to keep using Python 3.7 for their code, they all are okay with using 3.8+ to build the docs. To avoid breaking their requirements-dev.txt, we can use a conditional requirement on the docs requirements like ; python_version>3.7.

@Eric-Arellano Eric-Arellano removed the on hold On hold for now label May 24, 2023
Copy link
Collaborator

@coruscating coruscating left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me.

@Eric-Arellano Eric-Arellano merged commit bb3083e into Qiskit:main May 24, 2023
@Eric-Arellano Eric-Arellano deleted the furo-upgrade branch May 24, 2023 22:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add back Furo to setup.py install_requires
2 participants