Add lychee docs link checking

kkraus14 · kkraus14 · commit dfed5122978e · 2026-06-02T11:03:23.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,7 @@ __pycache__/
 
 # CUDA Python specific
 .cache/
+.lycheecache
 .pytest_cache/
 .benchmarks/
 *.cpp
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -42,6 +42,21 @@ repos:
         language: system
         files: '^.*/docs/source/.*\.md$'
 
+  # Link checking for authored documentation files
+  - repo: https://github.com/lycheeverse/lychee
+    rev: lychee-v0.24.2
+    hooks:
+      - id: lychee
+        args:
+          - LYCHEE_VERSION=0.24.2
+          - --cache
+          - --max-concurrency=4
+          - --max-retries=3
+          - --no-progress
+          - --exclude
+          - '^https://github\.com/NVIDIA/cuda-python/(blob|tree)/$'
+        files: '\.(md|rst)$'
+
   # Standard hooks
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: "3e8a8703264a2f4a69428a0aa4dcb512790b2c8c"  # frozen: v6.0.0
diff --git a/cuda_bindings/docs/source/conduct.rst b/cuda_bindings/docs/source/conduct.rst
@@ -1,4 +1,4 @@
-.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+.. SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 .. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
 
 Code of Conduct
@@ -85,7 +85,7 @@ Attribution
 -----------
 
 This Code of Conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org>`_, version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct/
 
 For answers to common questions about this code of conduct, see
 https://www.contributor-covenant.org/faq
diff --git a/cuda_bindings/docs/source/motivation.rst b/cuda_bindings/docs/source/motivation.rst
@@ -1,4 +1,4 @@
-.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+.. SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 .. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
 
 Motivation
@@ -31,7 +31,7 @@ you get the best of both worlds: rapid iterative development with Python and the
 speed of a compiled language targeting both CPUs and NVIDIA GPUs.
 
 `CuPy <https://cupy.dev/>`_ is a
-`NumPy <https://numpy.org/>`_/`SciPy <https://www.scipy.org/>`_ compatible Array
+`NumPy <https://numpy.org/>`_/`SciPy <https://scipy.org/>`_ compatible Array
 library, from `Preferred Networks <https://www.preferred.jp/en/>`_, for
 GPU-accelerated computing with Python. CUDA Python simplifies the CuPy build
 and allows for a faster and smaller memory footprint when importing the CuPy
diff --git a/cuda_bindings/docs/source/overview.rst b/cuda_bindings/docs/source/overview.rst
@@ -1,4 +1,4 @@
-.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+.. SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 .. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
 
 Overview
@@ -38,8 +38,8 @@ The first thing to do is import the `Driver
 API <https://docs.nvidia.com/cuda/cuda-driver-api/index.html>`_ and
 `NVRTC <https://docs.nvidia.com/cuda/nvrtc/index.html>`_ modules from the ``cuda.bindings``
 package. Next, we consider how to store host data and pass it to the device. Different
-approaches can be used to accomplish this and are described in `Preparing kernel
-arguments <https://nvidia.github.io/cuda-python/cuda-bindings/latest/overview.html#preparing-kernel-arguments>`_.
+approaches can be used to accomplish this and are described in
+:ref:`Preparing kernel arguments <preparing-kernel-arguments>`.
 In this example, we will use NumPy to store host data and pass it to the device, so let's
 import this dependency as well.
 
@@ -308,6 +308,8 @@ maximize performance ({numref}``Figure 1``).
 
    Screenshot of Nsight Compute CLI output of ``cuda.bindings`` example.
 
+.. _preparing-kernel-arguments:
+
 Preparing kernel arguments
 --------------------------
 
diff --git a/cuda_bindings/docs/source/release/11.7.1-notes.rst b/cuda_bindings/docs/source/release/11.7.1-notes.rst
@@ -1,4 +1,4 @@
-.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+.. SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 .. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
 
 CUDA Python 11.7.1 Release notes
@@ -14,6 +14,8 @@ Highlights
 Limitations
 -----------
 
+.. _cuda-bindings-11-7-1-source-builds:
+
 Source builds
 ^^^^^^^^^^^^^
 
diff --git a/cuda_bindings/docs/source/release/11.8.0-notes.rst b/cuda_bindings/docs/source/release/11.8.0-notes.rst
@@ -1,4 +1,4 @@
-.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+.. SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 .. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
 
 CUDA Python 11.8.0 Release notes
@@ -16,7 +16,7 @@ Highlights
 Source Builds
 ^^^^^^^^^^^^^
 
-CUDA Python source builds now parse CUDA headers located in $CUDA_HOME directory, enabling/disabling types and APIs if defined. Therefore this removes the need for CTK headers to have all types defined. By allowing minor variations, previous `11.7.1 mobile platform workaround <https://nvidia.github.io/cuda-python/release/11.7.1-notes.html#source-builds>`_ is no longer needed.
+CUDA Python source builds now parse CUDA headers located in $CUDA_HOME directory, enabling/disabling types and APIs if defined. Therefore this removes the need for CTK headers to have all types defined. By allowing minor variations, previous :ref:`11.7.1 mobile platform workaround <cuda-bindings-11-7-1-source-builds>` is no longer needed.
 
 It's still required that source builds use the latest CTK headers (i.e. “$CUDA_HOME/include” has latest CTK headers).
 
diff --git a/cuda_bindings/docs/source/release/12.9.6-notes.rst b/cuda_bindings/docs/source/release/12.9.6-notes.rst
@@ -31,7 +31,7 @@ Bugfixes
 
 * 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>`_)
 * Fixed a use-after-free in ``_HelperInputVoidPtr`` properties when backed by
   Python buffer objects.
   (`PR #1629 <https://github.com/NVIDIA/cuda-python/pull/1629>`_)
diff --git a/cuda_bindings/docs/source/release/13.1.1-notes.rst b/cuda_bindings/docs/source/release/13.1.1-notes.rst
@@ -1,4 +1,4 @@
-.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+.. SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 .. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
 
 .. module:: cuda.bindings
@@ -12,7 +12,7 @@ Highlights
 ----------
 
 * 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>`_)
 
 Experimental
 ------------
diff --git a/cuda_bindings/docs/source/release/13.2.0-notes.rst b/cuda_bindings/docs/source/release/13.2.0-notes.rst
@@ -39,7 +39,7 @@ Bugfixes
 
 * 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>`_)
 * Fixed ABI incompatibility bugs in cuFILE bindings introduced in v13.1.0.
   (`PR #1468 <https://github.com/NVIDIA/cuda-python/pull/1468>`_)
 * Fixed a use-after-free in ``_HelperInputVoidPtr`` properties when backed by
diff --git a/cuda_bindings/docs/source/support.rst b/cuda_bindings/docs/source/support.rst
@@ -1,4 +1,4 @@
-.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+.. SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 .. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
 
 .. _support:
@@ -38,7 +38,7 @@ The NVIDIA CUDA Python team reserves rights to amend the above support policy. A
 however, will be announced to the users in advance.
 
 
-.. _CUDA minor version compatibility: https://docs.nvidia.com/deploy/cuda-compatibility/#minor-version-compatibility
+.. _CUDA minor version compatibility: https://docs.nvidia.com/deploy/cuda-compatibility/minor-version-compatibility.html
 .. _CPython EOL schedule: https://devguide.python.org/versions/
 .. _built-in modules that are known to be thread-unsafe: https://github.com/python/cpython/issues/116738
 .. _free-threaded interpreter: https://docs.python.org/3/howto/free-threading-python.html
diff --git a/cuda_core/docs/source/conduct.rst b/cuda_core/docs/source/conduct.rst
@@ -1,4 +1,4 @@
-.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+.. SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 .. SPDX-License-Identifier: Apache-2.0
 
 Code of Conduct
@@ -85,7 +85,7 @@ Attribution
 -----------
 
 This Code of Conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org>`_, version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct/
 
 For answers to common questions about this code of conduct, see
 https://www.contributor-covenant.org/faq
diff --git a/cuda_python/docs/source/release/12.9.5-notes.rst b/cuda_python/docs/source/release/12.9.5-notes.rst
@@ -1,4 +1,4 @@
-.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+.. SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 .. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
 
 CUDA Python 12.9.5 Release notes
@@ -8,7 +8,7 @@ CUDA Python 12.9.5 Release notes
 Included components
 -------------------
 
-* `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>`_
 * `cuda.pathfinder 1.3.3 <https://nvidia.github.io/cuda-python/cuda-pathfinder/1.3.3/>`_
 
 
diff --git a/cuda_python/docs/source/release/12.9.6-notes.rst b/cuda_python/docs/source/release/12.9.6-notes.rst
@@ -7,7 +7,7 @@ CUDA Python 12.9.6 Release notes
 Included components
 -------------------
 
-* `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>`_
 * `cuda.pathfinder 1.4.2 <https://nvidia.github.io/cuda-python/cuda-pathfinder/1.4.2/release/1.4.2-notes.html>`_
 
 Known issues
