Skip to content

[codex] Add lychee docs link checks and stable source links#2159

Merged
kkraus14 merged 22 commits into
mainfrom
codex/docs-stable-source-linkcheck
Jun 9, 2026
Merged

[codex] Add lychee docs link checks and stable source links#2159
kkraus14 merged 22 commits into
mainfrom
codex/docs-stable-source-linkcheck

Conversation

@kkraus14

@kkraus14 kkraus14 commented Jun 1, 2026

Copy link
Copy Markdown
Collaborator

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

copy-pr-bot Bot commented Jun 1, 2026

Copy link
Copy Markdown
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 github-actions Bot 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 kkraus14 added the documentation Improvements or additions to documentation label Jun 1, 2026 — with ChatGPT Codex Connector
@kkraus14 kkraus14 added this to the cuda.bindings next milestone Jun 1, 2026
@kkraus14

kkraus14 commented Jun 1, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

@github-actions github-actions Bot added the cuda.pathfinder Everything related to the cuda.pathfinder module label Jun 1, 2026
@kkraus14

kkraus14 commented Jun 1, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

@github-actions

This comment has been minimized.

@kkraus14

kkraus14 commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

4 similar comments
@kkraus14

kkraus14 commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

@kkraus14

kkraus14 commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

@kkraus14

kkraus14 commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

@kkraus14

kkraus14 commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

Comment thread cuda_bindings/docs/source/conf.py Outdated
Comment thread cuda_bindings/docs/source/release/13.2.0-notes.rst Outdated
Comment thread cuda_bindings/docs/source/release/13.1.1-notes.rst Outdated
Comment thread cuda_bindings/docs/source/release/12.9.6-notes.rst Outdated
Comment thread .pre-commit-config.yaml
@kkraus14

kkraus14 commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

5 similar comments
@kkraus14

kkraus14 commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

@kkraus14

kkraus14 commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

@kkraus14

kkraus14 commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

@kkraus14

kkraus14 commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

@kkraus14

kkraus14 commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

@kkraus14

kkraus14 commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator Author

pre-commit.ci run

@kkraus14

kkraus14 commented Jun 2, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

5 similar comments
@kkraus14

kkraus14 commented Jun 3, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

@kkraus14

kkraus14 commented Jun 3, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

@kkraus14

kkraus14 commented Jun 3, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

@kkraus14

kkraus14 commented Jun 3, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

@kkraus14

kkraus14 commented Jun 3, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

Comment thread cuda_bindings/docs/source/module/runtime.rst Outdated
Comment thread cuda_bindings/docs/source/module/runtime.rst Outdated
@kkraus14 kkraus14 force-pushed the codex/docs-stable-source-linkcheck branch from 99910b2 to 809534b Compare June 9, 2026 02:58

@mdboom mdboom left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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

* `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>`_

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

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

* `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>`_

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto

Comment thread .github/workflows/check-doc-links.yml Outdated
@kkraus14

kkraus14 commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

@kkraus14

kkraus14 commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator Author

/ok to test

@kkraus14 kkraus14 merged commit a3dfb8c into main Jun 9, 2026
96 checks passed
@kkraus14 kkraus14 deleted the codex/docs-stable-source-linkcheck branch June 9, 2026 20:53
@github-actions

github-actions Bot commented Jun 9, 2026

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/CD CI/CD infrastructure cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module cuda.pathfinder Everything related to the cuda.pathfinder module documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants