Repository navigation
Omit autosummary pages in PR previews - #3244
Merged
Merged
Conversation
github-actions
Bot
added
the
cuda.bindings
mdboom
added
documentation
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Configure and announce preview output cuda_bindings_13/docs/source/conf.py |
Autosummary generation is disabled when BUILD_PREVIEW is truthy and enabled otherwise. The preview announcement states that autosummary-generated API pages are omitted. |
Priority:
Change: Other
Merge Risk: 
a86d7
-
No actionable merge-blocking risk was identified.
Comment @coderabbitai help to get the list of available commands.
Contributor
|
leofang
approved these changes
Oct 27, 2026
This file contains hidden or 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
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.
This is an implementation for Option #2 mentioned in #3231.
The suggestion in #3231 was to omit the autosummary pages only in the
_v2API (because this is where the vast majority of the /new/ usage was coming from). However, it is much simpler and easier to just omit all of the autosummary pages across all ofcuda_bindings, and I don't see any particular reason to treat_v2as special.While this removes the ability to visually inspect the output for these autogenerated classes, (1) these docs are auto-generated from the header files, so aren't really part of hand-written content in the cuda_bindings ever, (2) as of Aug 6, 2026 (MR !516) the generator validates that all of the docstrings it generates are valid Google docstring / reStructuredText format. So needing to test that the syntax is valid in
cuda_bindingsis much less necessary. Docstrings may still have incorrect formatting, but they will have valid formatting so will at least not break the doc build or through the rendered page into chaos.