Skip to content

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

Merged
cpcloud merged 1 commit intoNVIDIA:mainfrom
rwgk:pathfinder_api_rst_fixes
Mar 16, 2026
Merged

[doc-only] Sync pathfinder api.rst with public APIs in __init__.py#1765
cpcloud merged 1 commit intoNVIDIA:mainfrom
rwgk:pathfinder_api_rst_fixes

Conversation

@rwgk
Copy link
Copy Markdown
Collaborator

@rwgk rwgk commented Mar 15, 2026

The cuda_pathfinder/docs/source/api.rst file had diverged from the actual public APIs exported in cuda_pathfinder/cuda/pathfinder/__init__.py. This was discovered when a user reported that locate_nvidia_header_directory was missing from the documentation.

This PR brings api.rst in sync with __init__.py (which is the source of truth).

Other Changes:

  • Updated module description to mention bitcode and static libraries
  • Added developer reminder notes in both __init__.py and api.rst to help prevent future drift

- 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
@rwgk rwgk self-assigned this Mar 15, 2026
@rwgk rwgk added cuda.pathfinder Everything related to the cuda.pathfinder module bug Something isn't working labels Mar 15, 2026
@github-actions

This comment has been minimized.

@cpcloud cpcloud merged commit 4a8f674 into NVIDIA:main Mar 16, 2026
22 checks passed
@github-actions
Copy link
Copy Markdown

Doc Preview CI
Preview removed because the pull request was closed or merged.

@rwgk rwgk deleted the pathfinder_api_rst_fixes branch March 16, 2026 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working cuda.pathfinder Everything related to the cuda.pathfinder module

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants