[codex] Check versioned docs example links#2159
Draft
kkraus14 wants to merge 9 commits into
Draft
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. |
github-actions
Bot
added
CI/CD
kkraus14
added
the
documentation
ChatGPT Codex Connector
Collaborator
Author
|
/ok to test |
github-actions
Bot
added
the
cuda.pathfinder
Collaborator
Author
|
/ok to test |
|
Collaborator
Author
|
/ok to test |
Collaborator
Author
|
/ok to test |
Collaborator
Author
|
/ok to test |
Collaborator
Author
|
/ok to test |
Collaborator
Author
|
/ok to test |
kkraus14
commented
Jun 2, 2026
|
|
||
| def rewrite_source(app, docname, source): | ||
| text = source[0] | ||
| text = text.replace("|cuda_bindings_github_ref|", GITHUB_EXAMPLES_REF) |
Collaborator
Author
There was a problem hiding this comment.
Can we use a rst_epilog for this instead? https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-rst_epilog
| * Fixed an issue where the ``CU_POINTER_ATTRIBUTE_DEVICE_ORDINAL`` attribute was | ||
| retrieved as an unsigned int, rather than a signed int. | ||
| (`PR #1336 <https://github.com/NVIDIA/cuda-python/pull/1336>`_) | ||
| (`PR #1336 <https://github.com/NVIDIA/cuda-python/issues/1336>`_) |
Collaborator
Author
There was a problem hiding this comment.
This is the incorrect link, we should fix it
|
|
||
| * Add missing driver & runtime bindings for functions new in CTK 13.1.0 | ||
| (`PR #1321 <https://github.com/NVIDIA/cuda-python/pull/1321>`_) | ||
| (`PR #1321 <https://github.com/NVIDIA/cuda-python/issues/1321>`_) |
Collaborator
Author
There was a problem hiding this comment.
This should be 1337 which is the pull request addressing this issue
| * Fixed an issue where the ``CU_POINTER_ATTRIBUTE_DEVICE_ORDINAL`` attribute was | ||
| retrieved as an unsigned int, rather than a signed int. | ||
| (`PR #1336 <https://github.com/NVIDIA/cuda-python/pull/1336>`_) | ||
| (`PR #1336 <https://github.com/NVIDIA/cuda-python/issues/1336>`_) |
Collaborator
Author
|
/ok to test |
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
1 participant
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.
What changed
CUDA_PYTHON_DOCS_GITHUB_REFin the docs workflow so docs builds can link examples to the release tag for release docs and the exact build commit for preview/latest docs.cuda.coreandcuda.bindingsdocs configs to prefer that workflow-provided ref before falling back to the existing local-build behavior.linkcheckruns to thecuda.coreandcuda.bindingsdocs build scripts, enabled from the docs workflow, with linkcheck output written outside the deployed HTML tree.Why
This complements #2156 by making example source links stable for built docs and by letting CI fail when rendered docs contain broken external links.
Validation
git diff --check origin/main...HEADbash -n cuda_core/docs/build_docs.shbash -n cuda_bindings/docs/build_docs.shCUDA_PYTHON_DOCS_GITHUB_REFset and verifiedGITHUB_EXAMPLES_REFuses the provided ref.make -n linkchecksends output tobuild/linkcheck/<version>for both docs packages.Full docs/linkcheck was left to CI; local pixi validation started compiling the packages rather than just checking the docs configuration.