Skip to content

Update docs to use NVIDIA Sphinx theme#23035

Merged
rapids-bot[bot] merged 10 commits into
rapidsai:mainfrom
bdice:codex/nvidia-docs-theme
Jul 1, 2026
Merged

Update docs to use NVIDIA Sphinx theme#23035
rapids-bot[bot] merged 10 commits into
rapidsai:mainfrom
bdice:codex/nvidia-docs-theme

Conversation

@bdice

@bdice bdice commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Description

Updates the cuDF docs to use the NVIDIA Sphinx theme, following the same direction as rapidsai/rmm#2443.

This removes the local RAPIDS custom CSS/JS injection from the Sphinx and Doxygen docs configuration, switches the cuDF and dask-cuDF Sphinx configs to nvidia_sphinx_theme, and updates docs dependencies from pydata-sphinx-theme to nvidia-sphinx-theme.

Validation

  • Parsed edited Sphinx config files with ast.parse.
  • Parsed dependencies.yaml and generated conda environment YAML files with yaml.safe_load.
  • Ran commit-time pre-commit hooks, including RAPIDS dependency file generator.

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@copy-pr-bot

copy-pr-bot Bot commented Jun 29, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@github-actions github-actions Bot added the libcudf Affects libcudf (C++/CUDA) code. label Jun 29, 2026
Comment thread docs/cudf/source/cudf/developer_guide/documentation.md Outdated
@bdice
bdice marked this pull request as ready for review June 29, 2026 21:14
@bdice
bdice requested review from a team as code owners June 29, 2026 21:14
@bdice bdice changed the title [codex] Update docs to use NVIDIA Sphinx theme Update docs to use NVIDIA Sphinx theme Jun 29, 2026
@bdice bdice added doc Documentation non-breaking Non-breaking change labels Jun 29, 2026
@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Updates Sphinx documentation dependencies and configuration to use nvidia-sphinx-theme, adds sidebar navigation templates, and changes a PackedColumns null check in cudf_streaming.

Changes

Sphinx Theme Migration

Layer / File(s) Summary
Dependency specs updated
dependencies.yaml, conda/environments/all_cuda-*
Removes pydata-sphinx-theme>=0.15.4 and adds nvidia-sphinx-theme under pip: in all four conda environment files and dependencies.yaml.
Documentation config and asset cleanup
docs/cudf/source/conf.py, docs/dask_cudf/source/conf.py, cpp/doxygen/header.html, docs/cudf/source/cudf/developer_guide/documentation.md
Switches Sphinx themes to nvidia_sphinx_theme, removes html_logo, deletes remote CSS/JS injection, updates project names, removes custom Doxygen asset tags, and updates the theme reference in docs.
Sidebar navigation templates
docs/cudf/source/_templates/sidebar-nav-bs.html, docs/dask_cudf/source/_templates/sidebar-nav-bs.html
Adds sidebar templates that build section navigation from the active page and theme navigation settings.

PackedColumns Guard Fix

Layer / File(s) Summary
PackedColumns null check
python/cudf_streaming/cudf_streaming/partition_utils.pyx
Changes the non-empty PackedColumns guard to use packed_columns.c_obj.get() != NULL before releasing metadata and gpu_data.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • rapidsai/cudf#22352: Modifies Sphinx configuration in docs/cudf/source/conf.py, including html_theme and theme-related navigation settings.

Suggested labels

improvement

Suggested reviewers

  • wence-
  • rjzamora
  • madsbk
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: switching the docs to the NVIDIA Sphinx theme.
Description check ✅ Passed The description directly matches the changeset and covers the theme switch, dependency updates, and removal of custom CSS/JS.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@bdice bdice added the DO NOT MERGE Hold off on merging; see PR for details label Jun 29, 2026
@bdice
bdice requested a review from a team as a code owner June 29, 2026 22:06
@github-actions github-actions Bot added the Python Affects Python cuDF API. label Jun 29, 2026
@GPUtester GPUtester moved this to In Progress in cuDF Python Jun 29, 2026
@bdice
bdice force-pushed the codex/nvidia-docs-theme branch from 0c1d5cc to d7de68d Compare June 29, 2026 22:19

@vyasr vyasr 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.

Couple of questions about simplifying and documenting the jinja template we're adding, but otherwise looks great. Thanks for figuring this out Bradley!

Comment thread docs/dask_cudf/source/_templates/sidebar-nav-bs.html
Comment thread docs/cudf/source/_templates/sidebar-nav-bs.html
Comment thread python/cudf_streaming/cudf_streaming/partition_utils.pyx
@bdice bdice removed the DO NOT MERGE Hold off on merging; see PR for details label Jul 1, 2026
@bdice

bdice commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

/merge

@rapids-bot
rapids-bot Bot merged commit 11af57b into rapidsai:main Jul 1, 2026
139 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in cuDF Python Jul 1, 2026
rapids-bot Bot pushed a commit that referenced this pull request Jul 7, 2026
- uses `NVIDIA cuDF` for the documentation project and landing-page branding
- removes the inactive Twitter/X link and retains the GitHub icon
- removes the RAPIDS logo from the landing page so the theme default NVIDIA logo is used
- uses `NVIDIA cuDF Documentation` consistently for HTML, LaTeX, man, and Texinfo output

Follow-up to rapidsai/build-planning#300 and #23035.

## Validation

- Doxygen generation passes
- strict Sphinx HTML build passes with `-n -W --keep-going` and notebook execution disabled
- the notebook-executing build reaches HTML rendering but the `10min` notebook fails with an unrelated `CUDA_ERROR_ILLEGAL_ADDRESS` in the local GPU environment
- targeted pre-commit hooks pass

Authors:
  - Bradley Dice (https://github.com/bdice)

Approvers:
  - Matthew Roeschke (https://github.com/mroeschke)

URL: #23079
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation libcudf Affects libcudf (C++/CUDA) code. non-breaking Non-breaking change Python Affects Python cuDF API.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants