-
Notifications
You must be signed in to change notification settings - Fork 216
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
Conversation
Co-authored-by: leofang <[email protected]>
Co-authored-by: leofang <[email protected]>
cuda.pathfinder
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cuda_pathfinder/docs/source/_static/images/Nsight-Compute-CLI-625x473.png
Outdated
Show resolved
Hide resolved
…s, populate API docs Co-authored-by: leofang <[email protected]>
I've addressed all the review feedback in commit 12c065f:
The documentation should now be consistent with the cuda-core format and ready for review. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
/ok to test 12c065f |
This comment has been minimized.
This comment has been minimized.
@copilot please update the doc preview CI to also show pathfinder docs |
Co-authored-by: leofang <[email protected]>
pre-commit.ci autofix |
…rated documentation.
…the load_nvidia_dynamic_lib() docstring.
/ok to test |
@rwgk, there was an error processing your request: See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/1/ |
/ok to test d5c5b79 |
cuda_pathfinder/cuda/pathfinder/_dynamic_libs/load_nvidia_dynamic_lib.py
Show resolved
Hide resolved
Co-authored-by: Leo Fang <[email protected]>
/ok to test |
@rwgk, there was an error processing your request: See the following link for more information: https://docs.gha-runners.nvidia.com/cpr/e/1/ |
/ok to test a97918e |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, thanks Ralf!
Looks like I cannot merge my own PR. |
|
This PR implements comprehensive Sphinx documentation for
cuda.pathfinder
to replace the current README-only documentation approach.Changes Made
Documentation Infrastructure
cuda_pathfinder/docs/
following the established CUDA Python documentation patternsnv-versions.json
containing version 1.1.0 and latestDocumentation Content
cuda.pathfinder
README content rendered as proper Sphinx documentationcuda.pathfinder.SUPPORTED_NVIDIA_LIBNAMES
constantcuda.pathfinder.load_nvidia_dynamic_lib()
functioncuda.pathfinder.LoadedDL
classcuda.pathfinder.DynamicLibNotFoundError
exceptionIntegration Updates
cuda_python/docs/source/index.rst
) to link to new Sphinx docs instead of raw READMEREADME.md
to point to the new documentation URL:https://nvidia.github.io/cuda-python/cuda-pathfinder/latest
build_all_docs.sh
script to include pathfinder documentation in the complete build processbuild-docs.yml
) to handlecuda-pathfinder
as both an individual component and part of the "all" components buildBuild System
./build_docs.sh
or as part of the complete documentation suiteSPHINX_CUDA_PATHFINDER_VER
) for versioned buildsnv-versions.json
format for version management (removed legacyversions.json
)Documentation Standards
nv-versions.json
instead ofversions.json
The new documentation provides a professional, searchable interface that matches the existing CUDA Python documentation ecosystem while preserving all the detailed technical content from the original README.
New Documentation URLs:
Doc Preview URLs now include:
Fixes #760.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.