Update RMM docs to use NVIDIA theme#2443
Conversation
📝 WalkthroughWalkthroughThis PR migrates the documentation infrastructure from PyData Sphinx theme to NVIDIA Sphinx theme, removes Graphviz-based diagram generation across both Python and C++ documentation pipelines, updates the copyright year to 2026, and standardizes the project name capitalization. ChangesDocumentation Theme and Infrastructure Migration
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
dependencies.yaml (1)
349-350: ⚡ Quick winConsider pinning nvidia-sphinx-theme version.
Installing
nvidia-sphinx-themewithout a version constraint could lead to unexpected breaking changes if the theme is updated. Consider adding a version range for stability.📌 Suggested version constraint
- pip: - - nvidia-sphinx-theme + - nvidia-sphinx-theme>=1.0,<2.0🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@dependencies.yaml` around lines 349 - 350, The pip dependency entry for nvidia-sphinx-theme is unpinned; update the dependencies.yaml pip list entry for nvidia-sphinx-theme to include an explicit version constraint (either a fixed version like ==X.Y.Z or a safe range like >=X.Y,<X+1.0 or ~=X.Y) to prevent accidental breaking changes; locate the nvidia-sphinx-theme item in the pip list and replace the bare name with the chosen versioned specifier and run dependency resolution to verify compatibility.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@dependencies.yaml`:
- Around line 349-350: The pip dependency entry for nvidia-sphinx-theme is
unpinned; update the dependencies.yaml pip list entry for nvidia-sphinx-theme to
include an explicit version constraint (either a fixed version like ==X.Y.Z or a
safe range like >=X.Y,<X+1.0 or ~=X.Y) to prevent accidental breaking changes;
locate the nvidia-sphinx-theme item in the pip list and replace the bare name
with the chosen versioned specifier and run dependency resolution to verify
compatibility.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 5e3a806b-1bb6-4190-8c0a-d864b8d0ad5e
📒 Files selected for processing (9)
conda/environments/all_cuda-129_arch-aarch64.yamlconda/environments/all_cuda-129_arch-x86_64.yamlconda/environments/all_cuda-132_arch-aarch64.yamlconda/environments/all_cuda-132_arch-x86_64.yamlcpp/doxygen/Doxyfilecpp/doxygen/header.htmldependencies.yamldocs/conf.pydocs/cpp/memory_resources/index.md
💤 Files with no reviewable changes (1)
- cpp/doxygen/header.html
josephine-wolf-oberholtzer
left a comment
There was a problem hiding this comment.
Sphinx changes LGTM. Can't comment on the rest.
|
|
||
| Memory resources implement allocation and deallocation for a kind of memory, for example CUDA device memory, managed memory, or pinned host memory. Resource adaptors wrap another memory resource and change its behavior, such as adding logging, tracking, limits, alignment, or prefetching, while delegating the actual allocation to the wrapped upstream resource. | ||
|
|
||
| Use the pages below to browse the core memory resource implementations and the adaptors that add behavior to an upstream resource. |
There was a problem hiding this comment.
nit: I would probably remove this sentence.
Description
Updates the RMM docs to use the NVIDIA Sphinx theme, removes the local RAPIDS custom CSS/JS includes that are injected by docs post-processing, disables Doxygen dot graph generation to avoid the Graphviz/GTK/Wayland dependency chain, and adds context to the C++ memory resources landing page.
Checklist
Validation: ran
make clean; make htmlfromdocs/; commit hooks passed.