Skip to content

Update sphinx and the related packages #6400

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.

Sign up for GitHub

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

Jump to bottom
Closed
pavoljuhas opened this issue Jan 8, 2024 · 5 comments
Closed

Update sphinx and the related packages #6400

pavoljuhas opened this issue Jan 8, 2024 · 5 comments
Assignees
@smburdick
Labels
good first issue This issue can be resolved by someone who is not familiar with the codebase. A good starting issue. kind/health For CI/testing/release process/refactoring/technical debt items no QC knowledge needed Want to contribute to Cirq, but don't know quantum computing? This issue is for you. priority/p1 Fix is needed as soon as possible. Should be staffed. It is blocking some major flows for users skill-level/beginner No background required, self-contained issue triage/discuss Needs decision / discussion, bring these up during Cirq Cynque

Comments

@pavoljuhas
Copy link
Collaborator

Description of the issue

Problem: The current requirements pin sphinx to version 3.2.* which is too old for recent releases of its alabaster theme package - see the CI error here

Solution: Update sphinx and any dependent packages to their recent versions. Sphinx is currently at version 7.2.6, https://pypi.org/project/Sphinx/#history.

Cirq version

1.4.0.dev at d33b1a7.
@pavoljuhas pavoljuhas added the kind/health For CI/testing/release process/refactoring/technical debt items label Jan 8, 2024
@pavoljuhas pavoljuhas mentioned this issue Jan 8, 2024
Merged
@pavoljuhas pavoljuhas added no QC knowledge needed Want to contribute to Cirq, but don't know quantum computing? This issue is for you. good first issue This issue can be resolved by someone who is not familiar with the codebase. A good starting issue. triage/discuss Needs decision / discussion, bring these up during Cirq Cynque skill-level/beginner No background required, self-contained issue labels Jan 8, 2024
pavoljuhas added a commit that referenced this issue Jan 8, 2024
@pavoljuhas
Fix "Build docs" CI job by temporarily pinning alabaster to 0.7.13 (#…
8a7f675 
…6399)

As of alabaster-0.7.14 the alabaster theme package requires sphinx 3.4
which conflicts with the current sphinx requirement.

As a quick fix we pin to alabaster-0.7.13 here.

Temporary workaround for #6400
@smburdick
Copy link
Contributor

I can take this on

@pavoljuhas
Copy link
Collaborator Author

Sure, Thank you!

@pavoljuhas pavoljuhas mentioned this issue Jan 16, 2024
Merged
pavoljuhas added a commit to pavoljuhas/Cirq that referenced this issue Jan 16, 2024
@pavoljuhas
Pin sphinx dependencies that require Sphinx 5.0 or later
da8daa2 
Fixes quantumlib#6413

Temporary workaround for quantumlib#6400
@pavoljuhas pavoljuhas added the priority/p1 Fix is needed as soon as possible. Should be staffed. It is blocking some major flows for users label Jan 16, 2024
@pavoljuhas
Copy link
Collaborator Author

@smburdick - this seems a bit urgent, as the current state results in CI failures, for example, #6413.

Are you available to do a PR in a next few days?

No worries if you have other commitments. I can take over on this one and there will be a plenty of other issues to help us with in the future. :-)

@pavoljuhas
Copy link
Collaborator Author

cc @tanujkhattar

@smburdick
Copy link
Contributor

Taking a look. If I make no progress today, I will hand it back to you @pavoljuhas

@smburdick smburdick mentioned this issue Jan 16, 2024
Merged
pavoljuhas added a commit that referenced this issue Jan 16, 2024
@pavoljuhas
Pin sphinx dependencies that require Sphinx 5.0 or later (#6414)
8ae5bbb 
Fixes #6413

Temporary workaround for #6400
pavoljuhas added a commit to pavoljuhas/Cirq that referenced this issue Jan 17, 2024
@pavoljuhas
Require Sphinx-7.* instead of Sphinx-7.2.*
152d47e 
Remove package pinning workarounds introduced for quantumlib#6400.
Also remove an old pinning of the Jinja2 package which
is unlikely to be still needed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@smburdick smburdick

Labels
good first issue This issue can be resolved by someone who is not familiar with the codebase. A good starting issue. kind/health For CI/testing/release process/refactoring/technical debt items no QC knowledge needed Want to contribute to Cirq, but don't know quantum computing? This issue is for you. priority/p1 Fix is needed as soon as possible. Should be staffed. It is blocking some major flows for users skill-level/beginner No background required, self-contained issue triage/discuss Needs decision / discussion, bring these up during Cirq Cynque
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pavoljuhas @smburdick