Skip to content

[doc-only] docs: Add the v2 migration guide to a toctree - #3387

Merged
mdboom merged 1 commit into
NVIDIA:mainfrom
mdboom:issue3383
Nov 5, 2026
Merged

mdboom merged 1 commit into
NVIDIA:mainfrom
mdboom:issue3383

Conversation

@mdboom

@mdboom mdboom commented Nov 5, 2026

Copy link
Copy Markdown
Contributor

Part of #3383.

module/v2_migration was not included in any toctree, which produced the Sphinx warning document isn't included in any toctree. This adds it to a new "Migration guides" section at the bottom of the API reference and renames the module toctree caption from the CaptionHolder: placeholder to Modules:.

A clean local docs build of cuda_bindings_13 against the 13.5.0 source goes from 102 to 101 warnings, with no new warnings. The remaining warnings are from generated files (cybind) or are covered by #3385 and #3386.

🤖 Generated with Claude Code

module/v2_migration was not in any toctree, which produced a Sphinx
"document isn't included in any toctree" warning. Add it to its own
"Migration guides" section at the bottom of the API reference, and
rename the module toctree caption from the "CaptionHolder:" placeholder
to "Modules:".

Part of NVIDIA#3383.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@mdboom mdboom self-assigned this Nov 5, 2026
@github-actions github-actions Bot added the cuda.bindings Everything related to the cuda.bindings module label Nov 5, 2026
@mdboom mdboom added the documentation Improvements or additions to documentation label Nov 5, 2026
@mdboom mdboom added this to the cuda.bindings next milestone Nov 5, 2026
@coderabbitai

coderabbitai Bot commented Nov 5, 2026

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Summary

Summary by CodeRabbit

  • Documentation
    • Updated the API documentation navigation with a “Modules” section and a link to the v2 migration guide.

The API documentation changes the module toctree caption to “Modules” and adds a toctree linking to the v2 migration guide.

Changes: API documentation navigation

Layer / File(s) Summary
Toctree updates
cuda_bindings_13/docs/source/api.rst
The module toctree caption changes to “Modules.” A new toctree links to module/v2_migration with a maximum depth of 1.

Possibly related issues

  • NVIDIA/cuda-python issue 3383: This PR addresses one warning in the Sphinx warning cleanup tracked by the issue.

Possibly related PRs

Suggested reviewers: vzhurba01, rwgk

Change: Other

Merge Risk: Minimal · up to f34f9

The documentation navigation change has no identified merge-blocking risk.

- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between e01e453 and f34f988.

Files selected for processing: 1

  • cuda_bindings_13/docs/source/api.rst

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 8 remain after this review.

@github-actions

github-actions Bot commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor
Doc Preview CI
Preview removed because the pull request was closed or merged.

@lijinf2 lijinf2 left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Non-blocking nit: a few functions appear more than once in the guide's function tables (e.g. cuLaunchCooperativeKernelMultiDevice, cuTexRefSetAddressMode, cuTexRefSetFilterMode). This pre-view link: https://nvidia.github.io/cuda-python/pr-preview/pr-3387/cuda-bindings/latest/module/v2_migration.html.

Should we fix that? @mdboom

@mdboom
mdboom merged commit 0161596 into NVIDIA:main Nov 5, 2026
38 of 39 checks passed
github-actions Bot pushed a commit that referenced this pull request Nov 6, 2026
Removed preview folders for the following PRs:
- PR #3305
- PR #3332
- PR #3343
- PR #3368
- PR #3380
- PR #3387
- PR #3388
- PR #3389
- PR #3391
- PR #3393
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cuda.bindings Everything related to the cuda.bindings module documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants