Create Sphinx documentation infrastructure for cuda.pathfinder

Copilot · leofang · Copilot · commit 5aee727bf4e9 · 2025-08-21T18:39:55.000Z
Co-authored-by: leofang &lt;5534781+leofang@users.noreply.github.com&gt;
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -19,6 +19,7 @@ on:
         #   - cuda-core
         #   - cuda-bindings
         #   - cuda-python
+        #   - cuda-pathfinder
         #   - all
       git-tag:
         description: "Target git tag to build docs for"
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ CUDA Python is the home for accessing NVIDIA’s CUDA platform from Python. It c
 
 * [cuda.core](https://nvidia.github.io/cuda-python/cuda-core/latest): Pythonic access to CUDA Runtime and other core functionalities
 * [cuda.bindings](https://nvidia.github.io/cuda-python/cuda-bindings/latest): Low-level Python bindings to CUDA C APIs
-* [cuda.pathfinder](https://github.com/NVIDIA/cuda-python/blob/main/cuda_pathfinder/cuda/pathfinder/README.md): Utilities for locating CUDA components installed in the user's Python environment
+* [cuda.pathfinder](https://nvidia.github.io/cuda-python/cuda-pathfinder/latest): Utilities for locating CUDA components installed in the user's Python environment
 * [cuda.cccl.cooperative](https://nvidia.github.io/cccl/python/cooperative): A Python module providing CCCL's reusable block-wide and warp-wide *device* primitives for use within Numba CUDA kernels
 * [cuda.cccl.parallel](https://nvidia.github.io/cccl/python/parallel): A Python module for easy access to CCCL's highly efficient and customizable parallel algorithms, like `sort`, `scan`, `reduce`, `transform`, etc. that are callable on the *host*
 * [numba.cuda](https://nvidia.github.io/numba-cuda/): Numba's target for CUDA GPU programming by directly compiling a restricted subset of Python code into CUDA kernels and device functions following the CUDA execution model.
diff --git a/cuda_pathfinder/docs/Makefile b/cuda_pathfinder/docs/Makefile
@@ -0,0 +1,23 @@
+# SPDX-FileCopyrightText: Copyright (c) 2021-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
+
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?= -j auto
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build/html/${SPHINX_CUDA_PATHFINDER_VER}
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -b help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -b $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/cuda_pathfinder/docs/README.md b/cuda_pathfinder/docs/README.md
@@ -0,0 +1,11 @@
+# Build the documentation
+
+1. Install the `cuda-bindings` package of the version that we need to document.
+2. Ensure the version is included in the [`versions.json`](./versions.json).
+3. Build the docs with `./build_docs.sh`.
+4. The html artifacts should be available under both `./build/html/latest` and `./build/html/<version>`.
+
+Alternatively, we can build all the docs at once by running [`cuda_python/docs/build_all_docs.sh`](../../cuda_python/docs/build_all_docs.sh).
+
+To publish the docs with the built version, it is important to note that the html files of older versions
+should be kept intact, in order for the version selection (through `versions.json`) to work.
diff --git a/cuda_pathfinder/docs/build_docs.sh b/cuda_pathfinder/docs/build_docs.sh
@@ -0,0 +1,50 @@
+#!/bin/bash
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
+
+set -ex
+
+if [[ "$#" == "0" ]]; then
+    LATEST_ONLY="0"
+elif [[ "$#" == "1" && "$1" == "latest-only" ]]; then
+    LATEST_ONLY="1"
+else
+    echo "usage: ./build_docs.sh [latest-only]"
+    exit 1
+fi
+
+# SPHINX_CUDA_PATHFINDER_VER is used to create a subdir under build/html
+# (the Makefile file for sphinx-build also honors it if defined).
+# If there's a post release (ex: .post1) we don't want it to show up in the
+# version selector or directory structure.
+if [[ -z "${SPHINX_CUDA_PATHFINDER_VER}" ]]; then
+    export SPHINX_CUDA_PATHFINDER_VER=$(python -c "from importlib.metadata import version; \
+                                                 ver = '.'.join(str(version('cuda-pathfinder')).split('.')[:3]); \
+                                                 print(ver)" \
+                                      | awk -F'+' '{print $1}')
+fi
+
+# build the docs (in parallel)
+SPHINXOPTS="-j 4 -d build/.doctrees" make html
+
+# for debugging/developing (conf.py), please comment out the above line and
+# use the line below instead, as we must build in serial to avoid getting
+# obsecure Sphinx errors
+#SPHINXOPTS="-v" make html
+
+# to support version dropdown menu
+cp ./versions.json build/html
+
+# to have a redirection page (to the latest docs)
+cp source/_templates/main.html build/html/index.html
+
+# ensure that the latest docs is the one we built
+if [[ $LATEST_ONLY == "0" ]]; then
+    cp -r build/html/${SPHINX_CUDA_PATHFINDER_VER} build/html/latest
+else
+    mv build/html/${SPHINX_CUDA_PATHFINDER_VER} build/html/latest
+fi
+
+# ensure that the Sphinx reference uses the latest docs
+cp build/html/latest/objects.inv build/html
diff --git a/cuda_pathfinder/docs/make.bat b/cuda_pathfinder/docs/make.bat
@@ -0,0 +1,38 @@
+@ECHO OFF
+
+REM SPDX-FileCopyrightText: Copyright (c) 2021-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+REM SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/cuda_pathfinder/docs/nv-versions.json b/cuda_pathfinder/docs/nv-versions.json
@@ -0,0 +1,10 @@
+[
+    {
+        "version": "latest",
+        "url": "https://nvidia.github.io/cuda-python/cuda-pathfinder/latest/"
+    },
+    {
+        "version": "1.1.0",
+        "url": "https://nvidia.github.io/cuda-python/cuda-pathfinder/1.1.0/"
+    }
+]
diff --git a/cuda_pathfinder/docs/source/_static/images/Nsight-Compute-CLI-625x473.png b/cuda_pathfinder/docs/source/_static/images/Nsight-Compute-CLI-625x473.png
diff --git a/cuda_pathfinder/docs/source/_static/logo-dark-mode.png b/cuda_pathfinder/docs/source/_static/logo-dark-mode.png
diff --git a/cuda_pathfinder/docs/source/_static/logo-light-mode.png b/cuda_pathfinder/docs/source/_static/logo-light-mode.png
diff --git a/cuda_pathfinder/docs/source/_templates/main.html b/cuda_pathfinder/docs/source/_templates/main.html
@@ -0,0 +1,13 @@
+<!DOCTYPE HTML>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <meta http-equiv="refresh" content="0; url=latest/" />
+        <link rel="canonical" href="latest/" />
+    </head>
+    <body>
+        <p>If this page does not refresh automatically, then please direct your browser to
+            <a href="latest/">our latest cuda.pathfinder docs</a>.
+        </p>
+    </body>
+</html>
diff --git a/cuda_pathfinder/docs/source/api.rst b/cuda_pathfinder/docs/source/api.rst
@@ -0,0 +1,10 @@
+.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+.. SPDX-License-Identifier: Apache-2.0
+
+API Reference
+=============
+
+.. automodule:: cuda.pathfinder
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/cuda_pathfinder/docs/source/conf.py b/cuda_pathfinder/docs/source/conf.py
@@ -0,0 +1,103 @@
+# SPDX-FileCopyrightText: Copyright (c) 2012-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
+
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+import os
+
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "cuda.pathfinder"
+copyright = "2021-2025, NVIDIA"
+author = "NVIDIA"
+
+# The full version, including alpha/beta/rc tags
+release = os.environ["SPHINX_CUDA_PATHFINDER_VER"]
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.intersphinx",
+    "myst_nb",
+    "enum_tools.autoenum",
+    "sphinx_copybutton",
+]
+
+nb_execution_mode = "off"
+numfig = True
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_baseurl = "docs"
+html_theme = "nvidia_sphinx_theme"
+html_theme_options = {
+    "switcher": {
+        "json_url": "https://nvidia.github.io/cuda-python/cuda-pathfinder/nv-versions.json",
+        "version_match": release,
+    },
+    # Add light/dark mode and documentation version switcher
+    "navbar_center": [
+        "version-switcher",
+        "navbar-nav",
+    ],
+}
+if os.environ.get("CI"):
+    if int(os.environ.get("BUILD_PREVIEW", 0)):
+        PR_NUMBER = f"{os.environ['PR_NUMBER']}"
+        PR_TEXT = f'<a href="https://github.com/NVIDIA/cuda-python/pull/{PR_NUMBER}">PR {PR_NUMBER}</a>'
+        html_theme_options["announcement"] = f"<em>Warning</em>: This documentation is only a preview for {PR_TEXT}!"
+    elif int(os.environ.get("BUILD_LATEST", 0)):
+        html_theme_options["announcement"] = (
+            "<em>Warning</em>: This documentation is built from the development branch!"
+        )
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+# skip cmdline prompts
+copybutton_exclude = ".linenos, .gp"
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3/", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "nvvm": ("https://docs.nvidia.com/cuda/libnvvm-api/", None),
+    "nvjitlink": ("https://docs.nvidia.com/cuda/nvjitlink/", None),
+    "cufile": ("https://docs.nvidia.com/gpudirect-storage/api-reference-guide/", None),
+}
+
+suppress_warnings = [
+    # for warnings about multiple possible targets, see NVIDIA/cuda-python#152
+    "ref.python",
+]
diff --git a/cuda_pathfinder/docs/source/contribute.md b/cuda_pathfinder/docs/source/contribute.md
@@ -0,0 +1,12 @@
+# Contributing
+
+Thank you for your interest in contributing to `cuda-bindings`! Based on the type of contribution, it will fall into two categories:
+
+1. You want to report a bug, feature request, or documentation issue
+    - File an [issue](https://github.com/NVIDIA/cuda-python/issues/new/choose)
+    describing what you encountered or what you want to see changed.
+    - The NVIDIA team will evaluate the issues and triage them, scheduling
+    them for a release. If you believe the issue needs priority attention
+    comment on the issue to notify the team.
+2. You want to implement a feature, improvement, or bug fix:
+    - At this time we do not accept code contributions.
diff --git a/cuda_pathfinder/docs/source/index.rst b/cuda_pathfinder/docs/source/index.rst
@@ -0,0 +1,25 @@
+.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+.. SPDX-License-Identifier: Apache-2.0
+
+``cuda.pathfinder``: Utilities for locating CUDA components
+=========================================================
+
+.. include:: ../../cuda/pathfinder/README.md
+   :parser: myst_parser.sphinx_
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   api
+   support
+   contribute.md
+   license
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/cuda_pathfinder/docs/source/license.rst b/cuda_pathfinder/docs/source/license.rst
@@ -0,0 +1,8 @@
+.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+.. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
+
+Software License Agreement
+**************************
+
+.. literalinclude:: ../../LICENSE
+   :language: text
diff --git a/cuda_pathfinder/docs/source/support.rst b/cuda_pathfinder/docs/source/support.rst
@@ -0,0 +1,31 @@
+.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+.. SPDX-License-Identifier: LicenseRef-NVIDIA-SOFTWARE-LICENSE
+
+``cuda.bindings`` Support Policy
+================================
+
+The ``cuda.bindings`` module has the following support policy:
+
+1. The module shares the same ``major.minor`` version with the CUDA Toolkit. The patch version (the
+   third number in the version string), however, is reserved to reflect Python-only changes and
+   is out of sync with the Toolkit patch version.
+2. The module is actively maintained to support the latest CUDA major version and its prior major
+   version. For example, as of writing the bindings for CUDA 11 & 12 are maintained. Any fix in the
+   latest bindings would be backported to the prior major version.
+3. The module supports `CUDA minor version compatibility`_, meaning that ``cuda.bindings`` 12.x
+   supports any Toolkit 12.y. (Whether or not a binding API would actually correctly function
+   depends on the underlying driver and the Toolkit versions, as described in the compatibility
+   documentation.)
+4. The module supports all Python versions following the `CPython EOL schedule`_. As of writing
+   Python 3.9 - 3.13 are supported.
+5. The module exposes a Cython layer from which types and functions could be ``cimport``'d. While
+   we strive to keep this layer stable, due to Cython limitations a new *minor* release of this
+   module could require Cython layer users to rebuild their projects and update their pinning to
+   this module.
+
+The NVIDIA CUDA Python team reserves rights to amend the above support policy. Any major changes,
+however, will be announced to the users in advance.
+
+
+.. _CUDA minor version compatibility: https://docs.nvidia.com/deploy/cuda-compatibility/#minor-version-compatibility
+.. _CPython EOL schedule: https://devguide.python.org/versions/
diff --git a/cuda_pathfinder/docs/versions.json b/cuda_pathfinder/docs/versions.json
@@ -0,0 +1,4 @@
+{
+    "latest"  : "latest",
+    "1.1.0"   : "1.1.0"
+}
diff --git a/cuda_python/docs/build_all_docs.sh b/cuda_python/docs/build_all_docs.sh
@@ -28,3 +28,13 @@ rm -rf build
 ./build_docs.sh $@
 cp -r build/html/* "$(dirs -l +1)"/$CUDA_CORE_PATH
 popd
+
+# build cuda-pathfinder docs
+CUDA_PATHFINDER_PATH=build/html/cuda-pathfinder
+mkdir -p $CUDA_PATHFINDER_PATH
+pushd .
+cd ../../cuda_pathfinder/docs
+rm -rf build
+./build_docs.sh $@
+cp -r build/html/* "$(dirs -l +1)"/$CUDA_PATHFINDER_PATH
+popd
diff --git a/cuda_python/docs/source/index.rst b/cuda_python/docs/source/index.rst
@@ -35,7 +35,7 @@ be available, please refer to the `cuda.bindings`_ documentation for installatio
    release.md
    cuda.core <https://nvidia.github.io/cuda-python/cuda-core/latest>
    cuda.bindings <https://nvidia.github.io/cuda-python/cuda-bindings/latest>
-   cuda.pathfinder <https://github.com/NVIDIA/cuda-python/blob/main/cuda_pathfinder/cuda/pathfinder/README.md>
+   cuda.pathfinder <https://nvidia.github.io/cuda-python/cuda-pathfinder/latest>
    cuda.cccl.cooperative <https://nvidia.github.io/cccl/python/cooperative>
    cuda.cccl.parallel <https://nvidia.github.io/cccl/python/parallel>
    numba.cuda <https://nvidia.github.io/numba-cuda/>
