docstring in __init__.py, using #: Sphinx-specific markup

A triple-quoted docstring worked for Sphinx but tripped up the check-docstring-first pre-commit check.

Author: rwgk

cuda_pathfinder/cuda/pathfinder/__init__.py

@@ -1,15 +1,24 @@
 # SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+"""cuda.pathfinder public APIs"""
+
 from cuda.pathfinder._dynamic_libs.load_dl_common import DynamicLibNotFoundError as DynamicLibNotFoundError
 from cuda.pathfinder._dynamic_libs.load_dl_common import LoadedDL as LoadedDL
 from cuda.pathfinder._dynamic_libs.load_nvidia_dynamic_lib import load_nvidia_dynamic_lib as load_nvidia_dynamic_lib
 from cuda.pathfinder._dynamic_libs.supported_nvidia_libs import (
     SUPPORTED_LIBNAMES as SUPPORTED_NVIDIA_LIBNAMES,  # noqa: F401
 )
 from cuda.pathfinder._headers.find_nvidia_headers import find_nvidia_header_directory as find_nvidia_header_directory
-from cuda.pathfinder._headers.supported_nvidia_headers import SUPPORTED_HEADERS_CTK as SUPPORTED_HEADERS_CTK
+from cuda.pathfinder._headers.supported_nvidia_headers import SUPPORTED_HEADERS_CTK as _SUPPORTED_HEADERS_CTK
 from cuda.pathfinder._version import __version__ as __version__
 
+# Indirection to help Sphinx find the docstring.
+#: Mapping from short CUDA Toolkit (CTK) library names to their canonical
+#: header basenames (used to validate a discovered include directory).
+#: Example: ``"cublas" → "cublas.h"``. The key set is platform-aware
+#: (e.g., ``"cufile"`` may be Linux-only).
+SUPPORTED_HEADERS_CTK = _SUPPORTED_HEADERS_CTK
+
 # Backward compatibility with release 1.2.2. To be removed in release 1.2.4.
 _find_nvidia_header_directory = find_nvidia_header_directory

cuda_pathfinder/cuda/pathfinder/_headers/supported_nvidia_headers.py

@@ -34,10 +34,6 @@
 SUPPORTED_HEADERS_CTK_ALL = (
     SUPPORTED_HEADERS_CTK_COMMON | SUPPORTED_HEADERS_CTK_LINUX_ONLY | SUPPORTED_HEADERS_CTK_WINDOWS_ONLY
 )
-#: Mapping from short CUDA Toolkit (CTK) library names to their canonical
-#: header basenames (used to validate a discovered include directory).
-#: Example: ``"cublas" → "cublas.h"``. The key set is platform-aware
-#: (e.g., ``"cufile"`` may be Linux-only).
 SUPPORTED_HEADERS_CTK: Final[dict[str, str]] = (
     SUPPORTED_HEADERS_CTK_WINDOWS if IS_WINDOWS else SUPPORTED_HEADERS_CTK_LINUX
 )

toolshed/setup-docs-env.sh

@@ -65,4 +65,4 @@ echo "Build docs with e.g.:"
 echo "    conda activate ${ENV_NAME}"
 echo "    cd cuda_pathfinder/"
 echo "    pip install -e ."
-echo "    (cd docs/ && rm -rf build && ./build_docs.sh)"
+echo "    (cd docs/ && rm -rf build source/generated && ./build_docs.sh)"