Pin to recent breathe, to prevent getting an unsupported sphinx version. #1495
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bdice
added
bug
|
There are some warnings in CI that I don't know how to fix. https://github.com/rapidsai/rmm/actions/runs/8158164146/job/22300050680?pr=1495#step:9:1013 |
vyasr
added
doc
harrism
approved these changes
Mar 6, 2024
Comment on lines
+212
to
+217
| python_names_to_skip = [x for x in dir(int) if not x.startswith("__")] | ||
| if ( | ||
| node["refdomain"] == "py" | ||
| and (reftarget := node.get("reftarget")) is not None | ||
| and any(toskip in reftarget for toskip in python_names_to_skip) | ||
| ): |
There was a problem hiding this comment.
Nit: Could you just concatenate all the python names_to_skip that satisfy the refdomain/reftarget conditions with the C++ names to skip and have a single final any(toskip...) condition? Not sure if that would be more or less coherent.
There was a problem hiding this comment.
There is a difference in node["refdomain"] == "py" and node["refdomain"] == "cpp". I think that's enough reason to separate these.
There was a problem hiding this comment.
Ah, I missed the C++ side conditions because the any is inside the outer if on the Python side but in a nested one on the C++ side.
AyodeAwe
approved these changes
Mar 6, 2024
|
/merge |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The RMM nightly docs builds failed. https://github.com/rapidsai/rmm/actions/runs/8151286975/job/22279173933#step:9:973
It ran into an error reported in sphinx-doc/sphinx#11490. It seems like a viable fix (that is also minimal and somewhat future-proof) is to pin to a recent version of
breathe, which in turn forces a compatible version of sphinx. This is the same pinning used by cudf.Checklist