Skip to content

Enable public docs features in CI - #8533

Merged
josephine-wolf-oberholtzer merged 1 commit into
NVIDIA:mainfrom
bdice:enable-public-docs-features
Sep 1, 2026
Merged

Enable public docs features in CI#8533
josephine-wolf-oberholtzer merged 1 commit into
NVIDIA:mainfrom
bdice:enable-public-docs-features

Conversation

@bdice

@bdice bdice commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Contributes to rapidsai/build-planning#319

Enable the Sphinx theme's public_docs_features option when CI=true, while leaving local documentation builds unchanged.

@bdice bdice added non-breaking Non-breaking change improvement Improvement / enhancement to an existing function labels Aug 31, 2026
@copy-pr-bot

copy-pr-bot Bot commented Aug 31, 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 marked this pull request as ready for review August 31, 2026 22:12
@bdice
bdice requested a review from a team as a code owner August 31, 2026 22:12
@bdice
bdice requested a review from jcrist August 31, 2026 22:12
@coderabbitai

coderabbitai Bot commented Aug 31, 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: 42c29a39-d211-4c1e-89f9-d7305a1cb698

📥 Commits

Reviewing files that changed from the base of the PR and between da63d9a and 9b09dad.

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

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


📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Enabled additional public documentation features in continuous integration builds.

Walkthrough

Changes

Documentation theme configuration

Layer / File(s) Summary
Add CI-controlled theme option
docs/source/conf.py
Adds html_theme_options["public_docs_features"], enabled only when CI equals "true".

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

Merge Risk: ⚪ Minimal · up to 9b09d

The change enables the public documentation feature only for CI builds and leaves local documentation builds unchanged; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: jcrist, csadorf, betatim

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description accurately states that the Sphinx theme option is enabled only when CI=true and that local documentation builds remain unchanged.
Title check ✅ Passed The title clearly and concisely identifies the main change: enabling public documentation features in CI.
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 1…
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 1 files.

✨ 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 and removed improvement Improvement / enhancement to an existing function labels Aug 31, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@josephine-wolf-oberholtzer
josephine-wolf-oberholtzer merged commit 067c1e3 into NVIDIA:main Sep 1, 2026
60 of 65 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.

4 participants