[doc-only] Sync pathfinder api.rst with public APIs in __init__.py#1765
Merged
cpcloud merged 1 commit intoNVIDIA:mainfrom Mar 16, 2026
Merged
[doc-only] Sync pathfinder api.rst with public APIs in __init__.py#1765cpcloud merged 1 commit intoNVIDIA:mainfrom
cpcloud merged 1 commit intoNVIDIA:mainfrom
Conversation
- Add missing public APIs to api.rst:
- locate_nvidia_header_directory (function)
- LocatedHeaderDir (class)
- All bitcode library APIs (SUPPORTED_BITCODE_LIBS, find_bitcode_lib,
locate_bitcode_lib, LocatedBitcodeLib, BitcodeLibNotFoundError)
- All static library APIs (SUPPORTED_STATIC_LIBS, find_static_lib,
locate_static_lib, LocatedStaticLib, StaticLibNotFoundError)
- Remove SUPPORTED_HEADERS_NON_CTK from docs (not exported in __init__.py)
- Update module description to mention bitcode and static libraries
- Add developer notes in both files to keep them in sync
Made-with: Cursor
This comment has been minimized.
This comment has been minimized.
cpcloud
approved these changes
Mar 16, 2026
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
cuda_pathfinder/docs/source/api.rstfile had diverged from the actual public APIs exported incuda_pathfinder/cuda/pathfinder/__init__.py. This was discovered when a user reported thatlocate_nvidia_header_directorywas missing from the documentation.This PR brings
api.rstin sync with__init__.py(which is the source of truth).Other Changes:
__init__.pyandapi.rstto help prevent future drift