Skip to content

Fix cuda.core and cuda.bindings example links in docs#2156

Draft
uday1o1 wants to merge 1 commit into
NVIDIA:mainfrom
uday1o1:fix-cuda-core-example-links
Draft

Fix cuda.core and cuda.bindings example links in docs#2156
uday1o1 wants to merge 1 commit into
NVIDIA:mainfrom
uday1o1:fix-cuda-core-example-links

Conversation

@uday1o1
Copy link
Copy Markdown

@uday1o1 uday1o1 commented May 29, 2026

Summary

  • Replace raw cuda.core and cuda.bindings GitHub example URLs that used |..._github_ref| substitutions with Sphinx extlinks roles.
  • Update affected links in cuda_core/docs/source and cuda_bindings/docs/source.
  • Preserve version-aware behavior so latest/preview docs link to main, while release docs link to the appropriate release tag/ref.

Root Cause

The GitHub ref replacements were defined through rst_epilog, but they were used inside embedded hyperlink URI targets. Sphinx/Docutils left those substitutions literal in generated HTML, so browsers/GitHub saw URLs containing values like |cuda_core_github_ref| or |cuda_bindings_github_ref|. Those are treated as branch/tag names and the links return 404.

Validation

  • Crawled 250 live latest docs pages and found the affected pages were limited to cuda.core and cuda.bindings docs pages touched by this PR.
  • Built Sphinx smoke docs for:
    • cuda.core latest
    • cuda.core release 1.0.1
    • cuda.bindings latest
    • cuda.bindings release 13.3.0
  • Checked generated GitHub example links from all four smoke builds; all returned HTTP 200.
  • Confirmed generated HTML no longer contains cuda_core_github_ref, cuda_bindings_github_ref, or encoded %7Ccuda_... refs.
  • Ran git diff --check.

@copy-pr-bot
Copy link
Copy Markdown
Contributor

copy-pr-bot Bot commented May 29, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions github-actions Bot added the cuda.core Everything related to the cuda.core module label May 29, 2026
@uday1o1 uday1o1 force-pushed the fix-cuda-core-example-links branch from 5767c15 to 9a93adf Compare May 29, 2026 22:44
@github-actions github-actions Bot added the cuda.bindings Everything related to the cuda.bindings module label May 29, 2026
@github-actions
Copy link
Copy Markdown

Needs-Restricted-Paths-Review was assigned by CI: Restricted Paths Guard.

For details, open this workflow run and click Summary.

@github-actions github-actions Bot added the Needs-Restricted-Paths-Review PR touches cuda_bindings or cuda_python; only NVIDIA employees may modify these paths; see LICENSEs label May 29, 2026
@uday1o1 uday1o1 changed the title Fix cuda.core example links in docs Fix cuda.core and cuda.bindings example links in docs May 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module Needs-Restricted-Paths-Review PR touches cuda_bindings or cuda_python; only NVIDIA employees may modify these paths; see LICENSEs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant