Skip to content

Align RMM documentation branding - #2461

Merged
bdice merged 3 commits into
rapidsai:mainfrom
bdice:nvidia-doc-branding
Jul 7, 2026
Merged

Align RMM documentation branding#2461
bdice merged 3 commits into
rapidsai:mainfrom
bdice:nvidia-doc-branding

Conversation

@bdice

@bdice bdice commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

Description

  • uses NVIDIA RMM for the documentation project and landing-page branding
  • removes the inactive Twitter/X icon
  • uses NVIDIA RMM Documentation consistently for HTML, LaTeX, man, and Texinfo output
  • retains the GitHub icon and NVIDIA theme defaults

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

Validation

  • Doxygen generation passes
  • strict Sphinx HTML build passes with -n -W --keep-going
  • 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.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The Sphinx documentation configuration now uses NVIDIA RMM branding in generated titles, removes the X icon link, and updates the documentation index heading to match.

Changes

Documentation branding update

Layer / File(s) Summary
Update Sphinx branding and titles
docs/conf.py
The project variable changes to NVIDIA RMM, the X icon link is removed, and the LaTeX, man page, and Texinfo titles now use the project name.
Update docs index heading
docs/index.md
The documentation landing page title and intro line are updated to NVIDIA RMM branding.

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

Possibly related PRs

Suggested labels: doc, non-breaking

Suggested reviewers: msarahan, gforsyth

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title clearly matches the main change: updating RMM documentation branding to NVIDIA RMM.
Description check ✅ Passed The description accurately matches the documentation branding and icon-link changes in the PR.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@bdice

bdice commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator Author

Rendered from e1fe32e4.

Main page

RMM documentation main page

API reference

RMM API reference

@bdice bdice changed the title Add NVIDIA branding to documentation title Align RMM documentation branding Jul 2, 2026
@bdice
bdice marked this pull request as ready for review July 2, 2026 15:56
@bdice bdice added doc Documentation non-breaking Non-breaking change labels Jul 6, 2026
@bdice bdice self-assigned this Jul 6, 2026
@bdice bdice moved this to In Progress in RMM Project Board Jul 6, 2026
@bdice
bdice merged commit 9083943 into rapidsai:main Jul 7, 2026
47 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in RMM Project Board Jul 7, 2026
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

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant