-
Notifications
You must be signed in to change notification settings - Fork 214
Create new cuda-bindings release note files for missing milestone 14 improvements and link them in documentation #882
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
Create new cuda-bindings release note files for missing milestone 14 improvements and link them in documentation #882
Conversation
Co-authored-by: leofang <[email protected]>
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.
…e redundant content Co-authored-by: leofang <[email protected]>
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.
Thanks, @copilot. One last thing, the new rst files need to be linked in cuda_bindings/docs/source/release.rst
(or .md
, I forget) so that they are rendered by Sphinx. You know what to do 🙂
… rendering Co-authored-by: leofang <[email protected]>
Added both new release note files to the Sphinx toctree in |
|
This PR creates new cuda-bindings release note files to document missing improvements that were part of milestone 14 but were not included in the release notes, and ensures they are properly linked in the Sphinx documentation system.
Problem
Several important PRs merged as part of milestone 14 were missing from the cuda-bindings release notes:
These improvements significantly enhance the installation experience but were not reflected in the release documentation. Additionally, the new release note files needed to be properly linked in the Sphinx documentation system for rendering.
Solution
Created new release note files following the proper naming convention for future releases:
12.9.X-notes.rst
- Documents the automatic CUDA library path detection feature for the next 12.9 series release13.X.Y-notes.rst
- Documents the same feature for the next 13.x series releaseBoth files have been added to the Sphinx toctree in
release.rst
to ensure proper documentation rendering. The new files highlight the key improvement: automatic CUDA library path detection based onCUDA_HOME
, which eliminates the need to manually setLIBRARY_PATH
environment variables for installation.Impact
Users will have accurate and complete release documentation for future versions that reflects all the installation improvements delivered in milestone 14. The documentation now properly informs users about the elimination of manual
LIBRARY_PATH
setup requirements and improved installation robustness through automatic CUDA library detection. The files are now properly integrated into the documentation build system and will be rendered by Sphinx.✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.