Skip to content

Commit 6f432c9

Browse files
Copilotleofang
andcommitted
Refactor pathfinder documentation based on review feedback
- Remove lines 7-14 from api.rst (cuda.pathfinder automodule section) - Convert api.rst to use autosummary instead of direct autodoc directives following cuda-core pattern - Convert contribute.md to contribute.rst in ReST format - Remove _templates/main.html file as it's no longer needed - Update index.rst to reference contribute.rst instead of contribute.md Co-authored-by: leofang <5534781+leofang@users.noreply.github.com>
1 parent 169cfa8 commit 6f432c9

5 files changed

Lines changed: 33 additions & 58 deletions

File tree

cuda_pathfinder/docs/source/_templates/main.html

Lines changed: 0 additions & 13 deletions
This file was deleted.
Lines changed: 11 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,20 @@
11
.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
22
.. SPDX-License-Identifier: Apache-2.0
33
4-
API Reference
5-
=============
4+
.. module:: cuda.pathfinder
65

7-
cuda.pathfinder
8-
---------------
6+
``cuda.pathfinder`` API Reference
7+
=================================
98

10-
.. automodule:: cuda.pathfinder
11-
:members:
12-
:undoc-members:
13-
:show-inheritance:
9+
The ``cuda.pathfinder`` module provides utilities for loading NVIDIA dynamic libraries.
1410

1511
Public API
16-
----------
12+
-----------
1713

18-
The ``cuda.pathfinder`` module provides the following public API for loading NVIDIA dynamic libraries:
14+
.. autosummary::
15+
:toctree: generated/
1916

20-
Constants
21-
~~~~~~~~~
22-
23-
.. autodata:: cuda.pathfinder.SUPPORTED_NVIDIA_LIBNAMES
24-
:annotation: : tuple[str]
25-
26-
Functions
27-
~~~~~~~~~
28-
29-
.. autofunction:: cuda.pathfinder.load_nvidia_dynamic_lib
30-
31-
Classes
32-
~~~~~~~
33-
34-
.. autoclass:: cuda.pathfinder.LoadedDL
35-
:members:
36-
:undoc-members:
37-
38-
Exceptions
39-
~~~~~~~~~~
40-
41-
.. autoexception:: cuda.pathfinder.DynamicLibNotFoundError
17+
SUPPORTED_NVIDIA_LIBNAMES
18+
load_nvidia_dynamic_lib
19+
LoadedDL
20+
DynamicLibNotFoundError

cuda_pathfinder/docs/source/contribute.md

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
.. SPDX-License-Identifier: Apache-2.0
3+
4+
.. _contributor_guide:
5+
6+
Contributing
7+
------------
8+
9+
Thank you for your interest in contributing to ``cuda-pathfinder``! Based on the type of contribution, it will fall into two categories:
10+
11+
1. You want to report a bug, feature request, or documentation issue
12+
13+
- File an `issue <https://github.com/NVIDIA/cuda-python/issues/new/choose>`_
14+
describing what you encountered or what you want to see changed.
15+
- The NVIDIA team will evaluate the issues and triage them, scheduling
16+
them for a release. If you believe the issue needs priority attention
17+
comment on the issue to notify the team.
18+
19+
2. You want to implement a feature, improvement, or bug fix:
20+
21+
- 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>`_.

cuda_pathfinder/docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
:caption: Contents:
1313

1414
api
15-
contribute.md
15+
contribute
1616
license
1717

1818

0 commit comments

Comments
 (0)