Skip to content

Backport #8424 #8494: Publish API docs to docs.nvidia.com - #8525

Merged
josephine-wolf-oberholtzer merged 3 commits into
NVIDIA:release/26.08from
josephine-wolf-oberholtzer:josephine/backport-8424-8494
Aug 27, 2026
Merged

Backport #8424 #8494: Publish API docs to docs.nvidia.com#8525
josephine-wolf-oberholtzer merged 3 commits into
NVIDIA:release/26.08from
josephine-wolf-oberholtzer:josephine/backport-8424-8494

Conversation

@josephine-wolf-oberholtzer

Copy link
Copy Markdown
Contributor

Backports #8424 and #8494 to the release/26.08 branch so we can get 26.08 docs onto docs.nvidia.com.

Contributes to NVIDIA#8423 

Replace the (currently unused) hard-coded `version-map` with one we can set via `vars`.

This decouples updating the `versions.json` that powers the docs version switcher from code changes, making the docs release process simpler.

N.B. I'll be updating the docs publishing shared workflow to use this version map, but it currently doesn't.

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

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

URL: NVIDIA#8494
@josephine-wolf-oberholtzer josephine-wolf-oberholtzer added improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Aug 26, 2026
@coderabbitai

coderabbitai Bot commented Aug 26, 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: c3553e11-bcb6-4fd8-b7ff-74699c733477

📥 Commits

Reviewing files that changed from the base of the PR and between db709ac and 88d11ad.

📒 Files selected for processing (2)
  • .github/workflows/build.yaml
  • .github/workflows/pr.yaml

Included review availability: Your plan provides up to 12 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added automated API documentation publication for the cuml and libcuml projects.
    • Pull request builds now support dry-run documentation publishing to validate publication settings before release.
    • Documentation publishing now uses the upcoming release workflow configuration for consistent versioned API documentation.

Walkthrough

The build and pull request workflows add API documentation publication after docs-build. Build runs publish for branch references. Pull requests run in dry-run mode. Both target cuml and libcuml through the release/26.08 shared workflow.

Changes

API documentation publishing

Layer / File(s) Summary
Configure API documentation publication
.github/workflows/build.yaml, .github/workflows/pr.yaml
The workflows add publish-api-docs after docs-build, pass Akamai and AWS credentials, target cuml and libcuml, and use vars.VERSION_MAP. Build publication disables dry-run mode. Pull request publication enables dry-run mode and becomes a pr-builder dependency.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 88d11

This PR updates documentation publishing workflows for the 26.08 release branch. No actionable merge-blocking risk remains based on the supplied evidence.

Suggested reviewers: bdice, gforsyth, jameslamb

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the backport and the primary change: publishing API documentation to docs.nvidia.com.
Description check ✅ Passed The description explains that the pull request backports the changes to publish 26.08 API documentation to docs.nvidia.com. It matches the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@josephine-wolf-oberholtzer
josephine-wolf-oberholtzer merged commit 02caedb into NVIDIA:release/26.08 Aug 27, 2026
177 of 201 checks passed
@josephine-wolf-oberholtzer
josephine-wolf-oberholtzer deleted the josephine/backport-8424-8494 branch August 27, 2026 16:43
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.

3 participants