Skip to content

Backport #8449: Enable docs version picker - #8460

Merged
josephine-wolf-oberholtzer merged 1 commit into
NVIDIA:release/26.08from
josephine-wolf-oberholtzer:josephine/backport-8449
Aug 7, 2026
Merged

Backport #8449: Enable docs version picker#8460
josephine-wolf-oberholtzer merged 1 commit into
NVIDIA:release/26.08from
josephine-wolf-oberholtzer:josephine/backport-8449

Conversation

@josephine-wolf-oberholtzer

Copy link
Copy Markdown
Contributor

Backport of #8449, contributing to #8423 for the 26.08 release.

Contributes to NVIDIA#8423 

Let's enable the docs version picker.

N.B. I will backport this to 26.08 after the release to ensure it goes live for those docs.

Authors:
  - Joséphine Wolf Oberholtzer (https://github.com/josephine-wolf-oberholtzer)

Approvers:
  - Jim Crist-Harif (https://github.com/jcrist)

URL: NVIDIA#8449
@josephine-wolf-oberholtzer
josephine-wolf-oberholtzer requested a review from a team as a code owner August 6, 2026 16:26
@josephine-wolf-oberholtzer josephine-wolf-oberholtzer added improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Aug 6, 2026
@coderabbitai

coderabbitai Bot commented Aug 6, 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: 97c3de2d-9b32-40aa-9cbe-b78832904775

📥 Commits

Reviewing files that changed from the base of the PR and between 265b9da and 6443f86.

📒 Files selected for processing (1)
  • docs/source/conf.py

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added a version switcher to the documentation site.
    • Configured the switcher to display available cuML documentation versions and identify the current version.

Walkthrough

Configured the Sphinx HTML theme version switcher with the cuML versions manifest URL and the current documentation version.

Changes

Documentation version switcher

Layer / File(s) Summary
Sphinx switcher configuration
docs/source/conf.py
The HTML theme now uses the cuML versions manifest and current-version match value.

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

Possibly related PRs

  • rapidsai/cuml#8449: Both update docs/source/conf.py to configure the Sphinx documentation version switcher.

Suggested reviewers: betatim, jcrist, csadorf

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the backport and the main change: enabling the documentation version picker.
Description check ✅ Passed The description accurately relates the backport to the documentation version picker and the 26.08 release.
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.

@jcrist jcrist left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

:shipit:

@betatim

betatim commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Process question: in #8449 you said "I'll backport this after the release", is it already after the release? Kinda? I guess we don't need this to ship in any wheels/conda packages so we can wait to be sure to be sure?

@josephine-wolf-oberholtzer

Copy link
Copy Markdown
Contributor Author

@betatim I checked with @gforsyth yesterday. He basically said that the packages have been cut and uploaded to their respective destinations, so changes to the release branches won't alter those packages now.

@csadorf

csadorf commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

/merge

1 similar comment
@josephine-wolf-oberholtzer

Copy link
Copy Markdown
Contributor Author

/merge

@josephine-wolf-oberholtzer
josephine-wolf-oberholtzer merged commit 133c6e2 into NVIDIA:release/26.08 Aug 7, 2026
79 of 83 checks passed
@josephine-wolf-oberholtzer
josephine-wolf-oberholtzer deleted the josephine/backport-8449 branch August 7, 2026 17:11
@csadorf

csadorf commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

@betatim I checked with @gforsyth yesterday. He basically said that the packages have been cut and uploaded to their respective destinations, so changes to the release branches won't alter those packages now.

Does this mean we can make updates to published docs of stable releases by pushing to the releases branch if necessary?

@josephine-wolf-oberholtzer

josephine-wolf-oberholtzer commented Aug 7, 2026

Copy link
Copy Markdown
Contributor Author

@csadorf I believe so but:

  • Updates going to docs.rapidsai.com need to be built via https://github.com/rapidsai/docs. That repo builds the docs site daily, and you can also trigger the build manually.
  • Updates to 26.08 on docs.nvidia.com don't currently go out automatically because the GH action mechanism for that isn't on the release/26.08 branch, just main. Short term, I'm uploading those docs to their (not our) S3 bucket. For main and release/26.10 branches (and beyond) changes will go out automatically.

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

Labels

improvement Improvement / enhancement to an existing function non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants