Repository navigation
Add Sphinx documentation for cuda.pathfinder #884
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit
Hold shift + click to select a range
6e6d961
Initial plan
Copilot 5aee727
Create Sphinx documentation infrastructure for cuda.pathfinder
Copilot b1fbe08
Fix title underline and test pathfinder documentation build
Copilot 12c065f
Address all review feedback - fix references, remove unnecessary file…
Copilot e86e775
Add cuda-pathfinder documentation link to CI doc preview
Copilot 237df56
[pre-commit.ci] auto code formatting
pre-commit-ci[bot] 288a55b
Update cuda-core and cuda-bindings README to reference nv-versions.json
Copilot 169cfa8
Merge branch 'main' into copilot/fix-760
leofang 6f432c9
Refactor pathfinder documentation based on review feedback
Copilot 7f1e84e
Add release notes for cuda-pathfinder versions 1.0.0 and 1.1.0
Copilot d252872
Fix SPDX license identifiers and add 1.1.1 release notes for PRs #834…
Copilot 1f12c27
Restore _templates/main.html file as requested in review feedback
Copilot 224156d
Change format as requested by Leo
rwgk 9164130
Remove stray cuda/pathfinder/README.md URL in cuda_python/docs/source…
rwgk 3f10ec8
Merge branch 'main' into copilot/fix-760
rwgk 1006e2b
Rename release 1.1.1 to 1.X.Y
rwgk d096d21
Add version 1.0.0 in cuda_pathfinder/docs/nv-versions.json
rwgk 89d3564
Merge branch 'main' into copilot/fix-760
leofang 3d5d28b
Remove unused cuda_pathfinder/docs/make.bat
rwgk ecc5c19
Revert "Add version 1.0.0 in cuda_pathfinder/docs/nv-versions.json"
rwgk 100f18a
Reduce divergence between cuda_bindings/docs/source/contribute.rst an…
rwgk 1c0d6e8
Merge branch 'main' into copilot/fix-760
rwgk aebd77e
New pre-commit fixes (related to PR #901)
rwgk a7c8f89
Also remove version 1.1.0 from cuda_pathfinder/docs/nv-versions.json
rwgk 06bc1db
Reduce cuda/pathfinder/README.md to a mere pointer to the sphinx-gene…
rwgk d5c5b79
Add the Search order section from the old README as a new section in …
rwgk b324515
Leo's edits to new part of load_nvidia_dynamic_lib docstring
rwgk 5713624
Merge branch 'main' into copilot/fix-760
rwgk 3d9ca9e
Add more empty lines in load_nvidia_dynamic_lib docstring
rwgk 28d83dd
Remove `**` around Linux, Windows (for consistency)
rwgk ea8bd9a
Fix existing (on main) pre-commit error
rwgk c08ce51
Add `*/docs/source/generated/` to .gitignore
rwgk a97918e
Add toolshed/setup-docs-env.sh
rwgk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Address all review feedback - fix references, remove unnecessary file…
…s, populate API docs Co-authored-by: leofang <[email protected]>
- Loading branch information
There are no files selected for viewing
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
| 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. |
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
Binary file removed
BIN
-332 KB
cuda_pathfinder/docs/source/_static/images/Nsight-Compute-CLI-625x473.png
|
leofang marked this conversation as resolved.
Resolved
|
Binary file not shown.
|
leofang marked this conversation as resolved.
Resolved
|
Binary file not shown.
|
leofang marked this conversation as resolved.
Resolved
|
Binary file not shown.
|
leofang marked this conversation as resolved.
Resolved
leofang marked this conversation as resolved.
Resolved
|
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
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
|
leofang marked this conversation as resolved.
Resolved
leofang marked this conversation as resolved.
Resolved
|
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
| 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). |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,7 +12,6 @@ | |
| :caption: Contents: | ||
|
|
||
| api | ||
| support | ||
| contribute.md | ||
| license | ||
|
|
||
|
|
||
|
leofang marked this conversation as resolved.
Resolved
|
This file was deleted.
Oops, something went wrong.
|
leofang marked this conversation as resolved.
Resolved
|
This file was deleted.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.