Fix cuda.core API currentmodule for toolchain docs#2319
Merged
Conversation
Contributor
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
isVoid
added
the
documentation
ChatGPT Codex Connector
Contributor
Author
|
/ok to test |
This comment has been minimized.
This comment has been minimized.
Contributor
Author
|
Can verify that the PR is fixing the doc. Currently on public latest: After this PR: |
|
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
2 participants
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
Fixes the cuda.core API reference navigation for the CUDA compilation toolchain section.
The textures and surfaces section changes the active Sphinx module to
cuda.core.texture. Without resetting it, the following autosummary block resolves unqualified toolchain names such asProgram,Linker,ObjectCode, andKernelunder the texture namespace. The generated pages still exist, but the mainapi.htmlno longer links them under "CUDA compilation toolchain".This PR resets
currentmoduletocuda.corebefore the compilation toolchain autosummary so the entries resolve and render in the main API page again.Validation
pixi run --manifest-path cuda_core -e docs docs-build-latestcuda_core/docs/build/html/latest/api.htmllinkscuda.core.Program,cuda.core.Linker,cuda.core.ObjectCode,cuda.core.Kernel,cuda.core.ProgramOptions, andcuda.core.LinkerOptions.Note: the docs build completed successfully with one pre-existing warning from
release/1.0.0-notes.rstabout unknown documentsupport. A normalgit commithook run was blocked by the existing lychee pre-commit configuration requiring a versioned release tag for itsrev, so the commit was created with--no-verifyafter the docs build passed.