Skip to content

Align cuDF documentation branding#23079

Merged
rapids-bot[bot] merged 5 commits into
rapidsai:mainfrom
bdice:nvidia-doc-branding
Jul 7, 2026
Merged

Align cuDF documentation branding#23079
rapids-bot[bot] merged 5 commits into
rapidsai:mainfrom
bdice:nvidia-doc-branding

Conversation

@bdice

@bdice bdice commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Description

  • 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

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 Jul 2, 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.

@bdice

bdice commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

Rendered from ecde1957.

Main page

cuDF documentation main page

API reference

cuDF API reference

@bdice bdice changed the title Add NVIDIA branding to documentation titles Align cuDF documentation branding Jul 2, 2026
@bdice
bdice marked this pull request as ready for review July 2, 2026 15:55
@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 816ac76e-fe9a-4b47-856b-0290a69992f3

📥 Commits

Reviewing files that changed from the base of the PR and between ca1439c and ecde195.

📒 Files selected for processing (3)
  • docs/cudf/source/conf.py
  • docs/cudf/source/index.rst
  • docs/dask_cudf/source/conf.py

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated documentation branding to use NVIDIA product names for cuDF and Dask-cuDF.
    • Refreshed the documentation landing page title to match the new naming.
    • Standardized generated documentation titles across HTML, PDF, man pages, and texinfo outputs.
    • Removed an outdated social link from the documentation theme.

Walkthrough

Updates Sphinx documentation configuration for cuDF and Dask-cuDF: project names changed to "NVIDIA cuDF" and "NVIDIA Dask-cuDF", document titles now derive from the project variable, twitter_url removed from theme options, and cuDF index page header updated.

Changes

Docs Branding Update

Layer / File(s) Summary
cuDF Sphinx config and landing page
docs/cudf/source/conf.py, docs/cudf/source/index.rst
Project renamed to "NVIDIA cuDF", latex/man/texinfo titles now use f"{project} Documentation", twitter_url removed from html_theme_options, and index.rst header replaced with "NVIDIA cuDF Documentation".
Dask-cuDF Sphinx config
docs/dask_cudf/source/conf.py
Project renamed to "NVIDIA Dask-cuDF" and twitter_url removed from html_theme_options.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested labels: doc, non-breaking

Suggested reviewers: msarahan, simoneves, vyasr

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: updating cuDF documentation branding.
Description check ✅ Passed The description directly matches the branding and documentation output updates in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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 doc Documentation non-breaking Non-breaking change labels Jul 6, 2026
@bdice

bdice commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

/merge

@rapids-bot
rapids-bot Bot merged commit 5d7cfcf into rapidsai:main Jul 7, 2026
85 of 86 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants