Skip to content

[doc-only] Sync pathfinder api.rst with public APIs in __init__.py #1765

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cpcloud merged 1 commit into from
Mar 16, 2026
Merged

[doc-only] Sync pathfinder api.rst with public APIs in __init__.py #1765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions cuda_pathfinder/cuda/pathfinder/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@

"""cuda.pathfinder public APIs"""

# NOTE: When adding or removing public APIs from this file, remember to update
# cuda_pathfinder/docs/source/api.rst
# to keep the documentation in sync.

from cuda.pathfinder._binaries.find_nvidia_binary_utility import (
find_nvidia_binary_utility as find_nvidia_binary_utility,
)
Expand Down
21 changes: 19 additions & 2 deletions cuda_pathfinder/docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@
=================================

The ``cuda.pathfinder`` module provides utilities for loading NVIDIA dynamic libraries,
locating NVIDIA C/C++ header directories, and finding CUDA binary utilities.
locating NVIDIA C/C++ header directories, finding CUDA binary utilities, and locating
CUDA bitcode and static libraries.

.. NOTE: The source of truth for public APIs is cuda_pathfinder/cuda/pathfinder/__init__.py.
.. Keep this documentation in sync when adding or removing exports.

.. autosummary::
:toctree: generated/
Expand All @@ -20,8 +24,21 @@ locating NVIDIA C/C++ header directories, and finding CUDA binary utilities.
DynamicLibNotAvailableError

SUPPORTED_HEADERS_CTK
SUPPORTED_HEADERS_NON_CTK
find_nvidia_header_directory
locate_nvidia_header_directory
LocatedHeaderDir

SUPPORTED_BINARY_UTILITIES
find_nvidia_binary_utility

SUPPORTED_BITCODE_LIBS
find_bitcode_lib
locate_bitcode_lib
LocatedBitcodeLib
BitcodeLibNotFoundError

SUPPORTED_STATIC_LIBS
find_static_lib
locate_static_lib
LocatedStaticLib
StaticLibNotFoundError
Loading