Skip to content

[doc-only] docs: Fix footnotes on the cuda.bindings install page - #3388

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

mdboom merged 1 commit into
NVIDIA:mainfrom
mdboom:issue3384

Conversation

@mdboom

@mdboom mdboom commented Nov 5, 2026

Copy link
Copy Markdown
Contributor

Closes #3384

  • install.rst used Markdown-style footnotes ([^1], [^2], [^3]), which reST does not parse, so the markers and footnote text rendered literally. They are now auto-numbered reST footnotes ([#]_ references with matching .. [#] definitions).
  • Lists Windows arm64 as a supported platform in the install page's platform list.
  • The only other Markdown-style footnotes are in cuda_bindings_12/docs/source/install.md, which is Markdown and valid there.

Verified by rendering the Requirements section with docutils: three linked footnote references, no literal [^ left, no warnings. The full Sphinx build was not run locally.

🤖 Generated with Claude Code

Replace Markdown-style footnotes with reST footnotes, and list Windows
arm64 as a supported platform.

Closes NVIDIA#3384

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@github-actions github-actions Bot added the cuda.bindings Everything related to the cuda.bindings module label Nov 5, 2026
@mdboom mdboom self-assigned this 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 Windows platform support documentation to include ARM64.
    • Clarified source-build requirements, including Cython headers, the CUDA Runtime static library, and Git tag availability.

The install documentation now lists Windows arm64 support and uses reStructuredText footnotes for source-build requirements, including CUDA headers, the Runtime static library, and repository tags.

Changes: Source-build footnotes

Layer / File(s) Summary
ReStructuredText footnote references
cuda_bindings_13/docs/source/install.rst
The source-build requirements use reStructuredText footnotes. The notes describe the Cython CTK-header dependency, CUDA Runtime static library package, and reachable-tag requirements for repository clones.

Platform support

Layer / File(s) Summary
Windows arm64 support
cuda_bindings_13/docs/source/install.rst
The supported Windows architectures now include arm64. Linux support remains x86-64 and arm64.

Assessment against linked issues

Objective Addressed Explanation
Replace Markdown-style footnote markers with reStructuredText references and definitions [#3384] ✅
Check other install pages for the same Markdown-footnote pattern [#3384] ❓ The supplied change summary covers only cuda_bindings_13/docs/source/install.rst; it does not report checks of other install pages.

Out-of-scope changes

Code Change Explanation
Add Windows arm64 to supported architectures (cuda_bindings_13/docs/source/install.rst:12) The linked issue concerns reStructuredText footnote rendering and does not state a platform-support objective.

Possibly related issues

Suggested labels: documentation, cuda.bindings

Suggested reviewers: rwgk

Change: Other · Severity of issue fixed: Low

Merge Risk: Minimal · up to 8994a

The documentation update 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 8994a30.

Files selected for processing: 1

  • cuda_bindings_13/docs/source/install.rst

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 10 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.

👍

@mdboom
mdboom merged commit 692f301 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.

[DOC]: Footnote markers render literally on the cuda.bindings install page

2 participants