Skip to content

Update docs to use NVIDIA Sphinx theme#712

Open
bdice wants to merge 1 commit into
rapidsai:mainfrom
bdice:nvidia-sphinx-theme
Open

Update docs to use NVIDIA Sphinx theme#712
bdice wants to merge 1 commit into
rapidsai:mainfrom
bdice:nvidia-sphinx-theme

Conversation

@bdice

@bdice bdice commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Description

Updates the deployment documentation to use nvidia_sphinx_theme with the theme's default left navigation.

This replaces the previous Sphinx theme and custom RAPIDS logo/navigation assets, removes the legacy shared RAPIDS CSS/JavaScript injection, adds the GitHub icon, and aligns the landing-page branding with the other NVIDIA RAPIDS documentation.

Contributes to rapidsai/build-planning#300.

Validation

  • uv lock --check and a frozen dependency sync passed.
  • sphinx-build -E -b dirhtml source build/linux-dirhtml -W --keep-going -n passed on Linux.
  • Targeted pre-commit hooks passed.
  • Rendered HTML uses the default NVIDIA logo and left navigation, includes the GitHub icon, and contains no legacy shared RAPIDS asset URLs.

@bdice bdice requested a review from a team as a code owner July 6, 2026 18:49
@bdice

bdice commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

Rendered from 9118d33.

Main page

Deployment documentation main page

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not in the approvers list, but LGTM.

@jayavenkatesh19

jayavenkatesh19 commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

I spent some time looking through the Read the Docs build, and I noticed two things that are missing after this change (intentional or otherwise):

  • Nightly and Stable version switcher: The deleted nav.js added a selector in the page to jump between nightly/stable doc versions.
  • The Docs Home and Deployment Home links on the left navbar added by the same nav.js

I think not having links to the general RAPIDS and deployment docs is alright, but we might want to keep the Nightly/Stable version switcher. CCing @jacobtomlinson for his opinion about this.

Other than this, all functionality seems to be intact and good to go!

@bdice

bdice commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

Oh interesting! For all other projects, the nightly/stable switcher and other nav links are added when we deploy docs.rapids.ai. This project is different, it seems.

@jacobtomlinson

Copy link
Copy Markdown
Member

Here are some screenshots of some defects we've found

Purple headers

Some headers are still purple, I think this is some inline CSS.

image

Secondary sidebar not hiding

Some pages have the secondary sidebar disabled but this is not respected in the new theme and leads to dead whitespace on the right

image

Stable/Nightly switcher and Home buttons have gone

These navigation elements are missing

image

Tag underscores in sidebar

Tag links have underscore in between

image

Nav changes

The old theme has both top bar navigation for top level sections and left sidebar navigation for subsections. The new theme uses the sidebar only for all navigation. We might need to think a little about how we structured out navigation. For example the coda/pip/wsl pages are not showing on the nav on the left in the local section.

image

@bdice we are happy to take ownership of this PR and push fixes. We appreciate you kicking the ball off here but know you have a ton of these PRs to follow up on.

@bdice

bdice commented Jul 9, 2026

Copy link
Copy Markdown
Contributor Author

@jacobtomlinson Great, please take this and fix the issues you described, then merge when you're happy. Much appreciated!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants