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

require sphinx<8.2.0 #31

Merged
merged 1 commit into from
Feb 24, 2025
Merged

require sphinx<8.2.0 #31

merged 1 commit into from
Feb 24, 2025

Conversation

jameslamb
Copy link
Member

@jameslamb jameslamb commented Feb 21, 2025

Description

A pin like sphinx!=8.2.0 was added in #30, I'm guessing for similar reasons as documented in rapidsai/build-planning#155.

That can't be removed until some upstream changes are made in nbsphinx (linked in that issue). This proposes changing the pin to <8.2.0 (to prevent CI breaking again if an 8.2.1 or 8.3.0 is released) and adding a comment explaining when it can be removed.

Checklist

  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.
  • Run ./build.sh test for local testing, see CONTRIBUTING.md.
  • Ensure pre-commit checks are passing see CONTRIBUTING.md.

Signed-off-by: James Lamb <jlamb@nvidia.com>
Copy link
Contributor

@seberg seberg left a comment

Choose a reason for hiding this comment

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

Thanks, probably good to just put it in to keep things aligned; it doesn't really matter when exactly we check again if the issue needs a fix here or not.

I don't think nbsphinx is used here, so the issue(s) are probably different (one was a default parameter in a .pyi file, the other seemed like myst extension related).

@jameslamb
Copy link
Member Author

Ah ok thanks, I wasn't sure what led to that !=8.2.0, just assumed based on the timing that it was the same thing affecting other repos.

probably good to just put it in

Ok I'll merge this, thanks.

@jameslamb jameslamb merged commit 2d2b312 into rapidsai:main Feb 24, 2025
10 checks passed
@jameslamb jameslamb deleted the sphinx-pin branch February 24, 2025 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement Improves an existing functionality non-breaking Introduces a non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants