[codex] Add lychee docs link checks and stable source links by kkraus14 · Pull Request #2159 · NVIDIA/cuda-python

kkraus14 · 2026-06-01T19:37:48Z

What changed

Add lychee-based docs link checking for changed/new .rst and .md links through pre-commit.
Add a rendered-docs lychee CI workflow that runs after the docs build/deploy job.
Have the docs build workflow publish the rendered HTML tree as an artifact for the downstream lychee workflow.
Run rendered-docs lychee checks against the local generated HTML artifact instead of the deployed PR preview.
Make docs example source links stable by using CUDA_PYTHON_DOCS_GITHUB_REF for release, preview, and latest builds.
Apply stable source-link handling to cuda.bindings, cuda.core, cuda.pathfinder, and cuda-python docs.
Clean up known broken docs links so lychee has a passing baseline.

Split

This PR is now only the docs link-checking and stable source-link work. Generated cuda.bindings pyobj-reference and pointer-rendering artifacts were split into #2167.

The earlier Sphinx linkcheck and check_example_links.py experiments were removed; lychee is the link checker for both local changed-link checks and rendered HTML checks.

Validation

git diff --check origin/main...HEAD
pixi run pre-commit run actionlint --files .github/workflows/build-docs.yml .github/workflows/check-doc-links.yml .github/workflows/ci.yml
pixi run pre-commit run check-yaml --files .github/workflows/build-docs.yml .github/workflows/check-doc-links.yml .github/workflows/ci.yml
Pre-commit hooks ran during the original commits, including lychee.
Split verification: this PR only touches docs link checking/workflow/config/source docs files, not generated cuda.bindings Cython artifacts or generated pointer-rendering docs.

copy-pr-bot · 2026-06-01T19:37:52Z

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.

kkraus14 · 2026-06-01T20:19:52Z

/ok to test

kkraus14 · 2026-06-01T21:00:14Z

/ok to test

kkraus14 · 2026-06-02T15:04:18Z

/ok to test

kkraus14 · 2026-06-02T15:07:15Z

/ok to test

kkraus14 · 2026-06-02T15:28:19Z

/ok to test

kkraus14 · 2026-06-02T16:00:48Z

/ok to test

kkraus14 · 2026-06-02T16:30:48Z

/ok to test

kkraus14 · 2026-06-02T16:42:36Z

/ok to test

kkraus14 · 2026-06-02T16:51:59Z

/ok to test

kkraus14 · 2026-06-02T17:27:02Z

/ok to test

kkraus14 · 2026-06-02T17:58:32Z

/ok to test

kkraus14 · 2026-06-02T20:08:10Z

/ok to test

kkraus14 · 2026-06-02T21:03:47Z

/ok to test

kkraus14 · 2026-06-02T22:17:20Z

pre-commit.ci run

kkraus14 · 2026-06-02T22:26:22Z

/ok to test

kkraus14 · 2026-06-03T17:14:43Z

/ok to test

kkraus14 · 2026-06-03T17:35:18Z

/ok to test

kkraus14 · 2026-06-03T19:19:18Z

/ok to test

kkraus14 · 2026-06-03T20:12:34Z

/ok to test

kkraus14 · 2026-06-03T21:11:31Z

/ok to test

mdboom

Some minor comments, but nothing worth holding this up for.

mdboom · 2026-06-09T16:47:01Z

 -------------------

-* `cuda.bindings 12.9.5 <https://nvidia.github.io/cuda-python/cuda-bindings/12.9.5/release/12.9.5-notes.html>`_
+* `cuda.bindings 12.9.5 <https://nvidia.github.io/cuda-python/cuda-bindings/latest/release/12.9.5-notes.html>`_


This change doesn't seem right -- should this link to 12.9.5 always? If it intentionally goes to the latest, maybe remove the version from the displayed text?

It intentionally goes to the latest published historical 12.9.5 release notes. It's still going to the v12.9.5 release notes, but from the latest docs render.

mdboom · 2026-06-09T16:47:08Z

 -------------------

-* `cuda.bindings 12.9.6 <https://nvidia.github.io/cuda-python/cuda-bindings/12.9.6/release/12.9.6-notes.html>`_
+* `cuda.bindings 12.9.6 <https://nvidia.github.io/cuda-python/cuda-bindings/latest/release/12.9.6-notes.html>`_


kkraus14 · 2026-06-09T17:33:10Z

/ok to test

kkraus14 · 2026-06-09T17:42:53Z

/ok to test

github-actions · 2026-06-09T21:22:49Z

Doc Preview CI
Preview removed because the pull request was closed or merged.

github-actionsBot added CI/CD CI/CD infrastructure cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module labels Jun 1, 2026

kkraus14 added the documentation Improvements or additions to documentation label Jun 1, 2026 — with ChatGPT Codex Connector

kkraus14 added this to the cuda.bindings next milestone Jun 1, 2026

github-actionsBot added the cuda.pathfinder Everything related to the cuda.pathfinder module label Jun 1, 2026

This comment has been minimized.
Sign in to view

kkraus14 commented Jun 2, 2026
View reviewed changes

kkraus14 commented Jun 4, 2026
View reviewed changes

Comment threadcuda_bindings/docs/source/module/runtime.rst Outdated
Comment threadcuda_bindings/docs/source/module/runtime.rst Outdated

kkraus14 added 19 commits June 8, 2026 22:53

Check versioned docs example links
deec047

Add pathfinder docs linkcheck
8c67216

Check docs example links locally
bad8f0f

Add lychee docs link checking
3c880e6

Skip lychee on pre-commit.ci
d6466e9

Check rendered doc preview links with lychee
ed50484

Fix doc preview wait step
4a90b21

Use lychee-action default binary
8833364

Address docs review comments
451cdb1

Use fixed lychee-action revision
fbc91e2

Fix lychee fragment option syntax
a1ff984

Check deployed docs preview links
1bbd30a

Fix rendered docs linkcheck failures
14c70d0

Split rendered docs link check workflow
e7c5bac

Check rendered docs links locally
7f7bfa6

Clarify rendered docs artifact uploads
d16f283

Handle rendered docs linkcheck exclusions
1ace33e

Defer generated pointer docs cleanup
d1af887

Remove redundant docs commit hash env
809534b

kkraus14 force-pushed the codex/docs-stable-source-linkcheck branch from 99910b2 to 809534bCompare June 9, 2026 02:58

Note temporary rendered docs link exclusion
f6adcfb

mdboom approved these changes Jun 9, 2026
View reviewed changes

Use lychee release tag for pre-commit hook
22dde0a

kkraus14 mentioned this pull request Jun 9, 2026
[codex] Fix generated cuda-bindings problematic doc anchors #2186
Draft

Inline rendered docs link check
0a319ad

kkraus14 merged commit a3dfb8c into mainJun 9, 2026
96 checks passed

kkraus14 deleted the codex/docs-stable-source-linkcheck branch June 9, 2026 20:53

Uh oh!

Conversation

kkraus14 commented Jun 1, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changed

Split

Validation

Uh oh!

copy-pr-botBot commented Jun 1, 2026

Uh oh!

kkraus14 commented Jun 1, 2026

Uh oh!

kkraus14 commented Jun 1, 2026

Uh oh!

This comment has been minimized.

kkraus14 commented Jun 2, 2026

Uh oh!

kkraus14 commented Jun 2, 2026

Uh oh!

kkraus14 commented Jun 2, 2026

Uh oh!

kkraus14 commented Jun 2, 2026

Uh oh!

kkraus14 commented Jun 2, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kkraus14 commented Jun 2, 2026

Uh oh!

kkraus14 commented Jun 2, 2026

Uh oh!

kkraus14 commented Jun 2, 2026

Uh oh!

kkraus14 commented Jun 2, 2026

Uh oh!

kkraus14 commented Jun 2, 2026

Uh oh!

kkraus14 commented Jun 2, 2026

Uh oh!

kkraus14 commented Jun 2, 2026

Uh oh!

kkraus14 commented Jun 2, 2026

Uh oh!

kkraus14 commented Jun 3, 2026

Uh oh!

kkraus14 commented Jun 3, 2026

Uh oh!

kkraus14 commented Jun 3, 2026

Uh oh!

kkraus14 commented Jun 3, 2026

Uh oh!

kkraus14 commented Jun 3, 2026

Uh oh!

Uh oh!

Uh oh!

mdboom left a comment

Choose a reason for hiding this comment

Uh oh!

mdboomJun 9, 2026

Choose a reason for hiding this comment

Uh oh!

kkraus14Jun 9, 2026

Choose a reason for hiding this comment

Uh oh!

mdboomJun 9, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kkraus14 commented Jun 9, 2026

Uh oh!

kkraus14 commented Jun 9, 2026

Uh oh!

Uh oh!

github-actionsBot commented Jun 9, 2026

Uh oh!

Reviewers

Assignees

kkraus14 commented Jun 1, 2026•
edited
Loading