Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
6e6d961
Initial plan
Copilot Aug 21, 2025
5aee727
Create Sphinx documentation infrastructure for cuda.pathfinder
Copilot Aug 21, 2025
b1fbe08
Fix title underline and test pathfinder documentation build
Copilot Aug 21, 2025
12c065f
Address all review feedback - fix references, remove unnecessary file…
Copilot Aug 21, 2025
e86e775
Add cuda-pathfinder documentation link to CI doc preview
Copilot Aug 21, 2025
237df56
[pre-commit.ci] auto code formatting
pre-commit-ci[bot] Aug 21, 2025
288a55b
Update cuda-core and cuda-bindings README to reference nv-versions.json
Copilot Aug 21, 2025
169cfa8
Merge branch 'main' into copilot/fix-760
leofang Aug 21, 2025
6f432c9
Refactor pathfinder documentation based on review feedback
Copilot Aug 22, 2025
7f1e84e
Add release notes for cuda-pathfinder versions 1.0.0 and 1.1.0
Copilot Aug 23, 2025
d252872
Fix SPDX license identifiers and add 1.1.1 release notes for PRs #834…
Copilot Aug 23, 2025
1f12c27
Restore _templates/main.html file as requested in review feedback
Copilot Aug 25, 2025
224156d
Change format as requested by Leo
rwgk Aug 25, 2025
9164130
Remove stray cuda/pathfinder/README.md URL in cuda_python/docs/source…
rwgk Aug 25, 2025
3f10ec8
Merge branch 'main' into copilot/fix-760
rwgk Aug 25, 2025
1006e2b
Rename release 1.1.1 to 1.X.Y
rwgk Aug 25, 2025
d096d21
Add version 1.0.0 in cuda_pathfinder/docs/nv-versions.json
rwgk Aug 25, 2025
89d3564
Merge branch 'main' into copilot/fix-760
leofang Aug 25, 2025
3d5d28b
Remove unused cuda_pathfinder/docs/make.bat
rwgk Aug 25, 2025
ecc5c19
Revert "Add version 1.0.0 in cuda_pathfinder/docs/nv-versions.json"
rwgk Aug 25, 2025
100f18a
Reduce divergence between cuda_bindings/docs/source/contribute.rst an…
rwgk Aug 25, 2025
1c0d6e8
Merge branch 'main' into copilot/fix-760
rwgk Aug 25, 2025
aebd77e
New pre-commit fixes (related to PR #901)
rwgk Aug 25, 2025
a7c8f89
Also remove version 1.1.0 from cuda_pathfinder/docs/nv-versions.json
rwgk Aug 25, 2025
06bc1db
Reduce cuda/pathfinder/README.md to a mere pointer to the sphinx-gene…
rwgk Aug 25, 2025
d5c5b79
Add the Search order section from the old README as a new section in …
rwgk Aug 25, 2025
b324515
Leo's edits to new part of load_nvidia_dynamic_lib docstring
rwgk Aug 26, 2025
5713624
Merge branch 'main' into copilot/fix-760
rwgk Aug 26, 2025
3d9ca9e
Add more empty lines in load_nvidia_dynamic_lib docstring
rwgk Aug 26, 2025
28d83dd
Remove `**` around Linux, Windows (for consistency)
rwgk Aug 26, 2025
ea8bd9a
Fix existing (on main) pre-commit error
rwgk Aug 26, 2025
c08ce51
Add `*/docs/source/generated/` to .gitignore
rwgk Aug 26, 2025
a97918e
Add toolshed/setup-docs-env.sh
rwgk Aug 26, 2025
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
Prev Previous commit
Next Next commit
Address all review feedback - fix references, remove unnecessary file…
…s, populate API docs

Co-authored-by: leofang <[email protected]>
  • Loading branch information
Copilot and leofang committed Aug 21, 2025
commit 12c065fb7f441dc3722d14594c49a2a748853f38
6 changes: 3 additions & 3 deletions cuda_pathfinder/docs/README.md
Comment thread
leofang marked this conversation as resolved.
Resolved
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Build the documentation

1. Install the `cuda-bindings` package of the version that we need to document.
2. Ensure the version is included in the [`versions.json`](./versions.json).
1. Install the `cuda-pathfinder` package of the version that we need to document.
2. Ensure the version is included in the [`nv-versions.json`](./nv-versions.json).
3. Build the docs with `./build_docs.sh`.
4. The html artifacts should be available under both `./build/html/latest` and `./build/html/<version>`.

Alternatively, we can build all the docs at once by running [`cuda_python/docs/build_all_docs.sh`](../../cuda_python/docs/build_all_docs.sh).

To publish the docs with the built version, it is important to note that the html files of older versions
should be kept intact, in order for the version selection (through `versions.json`) to work.
should be kept intact, in order for the version selection (through `nv-versions.json`) to work.
2 changes: 1 addition & 1 deletion cuda_pathfinder/docs/build_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ SPHINXOPTS="-j 4 -d build/.doctrees" make html
#SPHINXOPTS="-v" make html

# to support version dropdown menu
cp ./versions.json build/html
cp ./nv-versions.json build/html

# to have a redirection page (to the latest docs)
cp source/_templates/main.html build/html/index.html
Expand Down
Comment thread
leofang marked this conversation as resolved.
Resolved
Binary file not shown.
Comment thread
leofang marked this conversation as resolved.
Resolved
Binary file not shown.
Comment thread
leofang marked this conversation as resolved.
Resolved
Binary file not shown.
31 changes: 31 additions & 0 deletions cuda_pathfinder/docs/source/api.rst
Comment thread
leofang marked this conversation as resolved.
Resolved
Comment thread
leofang marked this conversation as resolved.
Resolved
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,38 @@
API Reference
=============

cuda.pathfinder
---------------

.. automodule:: cuda.pathfinder
:members:
:undoc-members:
:show-inheritance:

Public API
----------

The ``cuda.pathfinder`` module provides the following public API for loading NVIDIA dynamic libraries:

Constants
~~~~~~~~~

.. autodata:: cuda.pathfinder.SUPPORTED_NVIDIA_LIBNAMES
:annotation: : tuple[str]

Functions
~~~~~~~~~

.. autofunction:: cuda.pathfinder.load_nvidia_dynamic_lib

Classes
~~~~~~~

.. autoclass:: cuda.pathfinder.LoadedDL
:members:
:undoc-members:

Exceptions
~~~~~~~~~~

.. autoexception:: cuda.pathfinder.DynamicLibNotFoundError
14 changes: 3 additions & 11 deletions cuda_pathfinder/docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
# -- Project information -----------------------------------------------------

project = "cuda.pathfinder"
copyright = "2021-2025, NVIDIA"
copyright = "2025, NVIDIA"
author = "NVIDIA"

# The full version, including alpha/beta/rc tags
Expand All @@ -35,7 +35,7 @@
# ones.
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.autosummary",
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"myst_nb",
Expand All @@ -44,6 +44,7 @@
]

nb_execution_mode = "off"

numfig = True

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -91,13 +92,4 @@

intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"nvvm": ("https://docs.nvidia.com/cuda/libnvvm-api/", None),
"nvjitlink": ("https://docs.nvidia.com/cuda/nvjitlink/", None),
"cufile": ("https://docs.nvidia.com/gpudirect-storage/api-reference-guide/", None),
}

suppress_warnings = [
# for warnings about multiple possible targets, see NVIDIA/cuda-python#152
"ref.python",
]
14 changes: 7 additions & 7 deletions cuda_pathfinder/docs/source/contribute.md
Comment thread
leofang marked this conversation as resolved.
Resolved
Comment thread
leofang marked this conversation as resolved.
Resolved
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Contributing

Thank you for your interest in contributing to `cuda-bindings`! Based on the type of contribution, it will fall into two categories:
Thank you for your interest in contributing to `cuda-pathfinder`! Based on the type of contribution, it will fall into two categories:

1. You want to report a bug, feature request, or documentation issue
- File an [issue](https://github.com/NVIDIA/cuda-python/issues/new/choose)
describing what you encountered or what you want to see changed.
- The NVIDIA team will evaluate the issues and triage them, scheduling
them for a release. If you believe the issue needs priority attention
comment on the issue to notify the team.
- File an [issue](https://github.com/NVIDIA/cuda-python/issues/new/choose)
describing what you encountered or what you want to see changed.
- The NVIDIA team will evaluate the issues and triage them, scheduling
them for a release. If you believe the issue needs priority attention
comment on the issue to notify the team.
2. You want to implement a feature, improvement, or bug fix:
- At this time we do not accept code contributions.
- Please ensure that your commits are signed [following GitHub's instruction](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification).
1 change: 0 additions & 1 deletion cuda_pathfinder/docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
:caption: Contents:

api
support
contribute.md
license

Expand Down
31 changes: 0 additions & 31 deletions cuda_pathfinder/docs/source/support.rst
Comment thread
leofang marked this conversation as resolved.
Resolved

This file was deleted.

4 changes: 0 additions & 4 deletions cuda_pathfinder/docs/versions.json
Comment thread
leofang marked this conversation as resolved.
Resolved

This file was deleted.