Skip to content

Commit 4a8f674

Browse files
authored
[doc-only] Sync pathfinder api.rst with public APIs in __init__.py (#1765)
1 parent 26542bd commit 4a8f674

File tree

2 files changed

+23
-2
lines changed

2 files changed

+23
-2
lines changed

cuda_pathfinder/cuda/pathfinder/__init__.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33

44
"""cuda.pathfinder public APIs"""
55

6+
# NOTE: When adding or removing public APIs from this file, remember to update
7+
# cuda_pathfinder/docs/source/api.rst
8+
# to keep the documentation in sync.
9+
610
from cuda.pathfinder._binaries.find_nvidia_binary_utility import (
711
find_nvidia_binary_utility as find_nvidia_binary_utility,
812
)

cuda_pathfinder/docs/source/api.rst

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@
77
=================================
88

99
The ``cuda.pathfinder`` module provides utilities for loading NVIDIA dynamic libraries,
10-
locating NVIDIA C/C++ header directories, and finding CUDA binary utilities.
10+
locating NVIDIA C/C++ header directories, finding CUDA binary utilities, and locating
11+
CUDA bitcode and static libraries.
12+
13+
.. NOTE: The source of truth for public APIs is cuda_pathfinder/cuda/pathfinder/__init__.py.
14+
.. Keep this documentation in sync when adding or removing exports.
1115
1216
.. autosummary::
1317
:toctree: generated/
@@ -20,8 +24,21 @@ locating NVIDIA C/C++ header directories, and finding CUDA binary utilities.
2024
DynamicLibNotAvailableError
2125

2226
SUPPORTED_HEADERS_CTK
23-
SUPPORTED_HEADERS_NON_CTK
2427
find_nvidia_header_directory
28+
locate_nvidia_header_directory
29+
LocatedHeaderDir
2530

2631
SUPPORTED_BINARY_UTILITIES
2732
find_nvidia_binary_utility
33+
34+
SUPPORTED_BITCODE_LIBS
35+
find_bitcode_lib
36+
locate_bitcode_lib
37+
LocatedBitcodeLib
38+
BitcodeLibNotFoundError
39+
40+
SUPPORTED_STATIC_LIBS
41+
find_static_lib
42+
locate_static_lib
43+
LocatedStaticLib
44+
StaticLibNotFoundError

0 commit comments

Comments
 (0)