Update documentation theme to Shibuya - #2242
Conversation
Signed-off-by: realAsma <akuriparambi@nvidia.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (4)
Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review. 📝 WalkthroughWalkthroughThe documentation site migrated from ChangesDocumentation theme migration
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: ⚪ Minimal · up to This documentation-only theme migration has passed the stated warning-as-error build and applicable formatting checks, with no actionable merge-blocking risk remaining beyond normal review. Suggested reviewers: 🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
Full details: Docstring CoverageExplanation 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. (3 skipped: 3 unsupported.) Full details: Security Anti-PatternsExplanation PASS. The PR changes only documentation CSS/configuration, ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2242 +/- ##
==========================================
- Coverage 79.01% 78.42% -0.59%
==========================================
Files 523 523
Lines 60695 60695
==========================================
- Hits 47960 47603 -357
- Misses 12735 13092 +357
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
What does this PR do?
Type of change: documentation.
Replaces the legacy Sphinx RTD theme with Shibuya and gives the ModelOpt documentation a modern responsive light/dark presentation.
The configuration uses the Shibuya green palette with NVIDIA green (#76b900) as the primary accent, follows the reader system color preference by default, enables dark code blocks, and expands the first level of global navigation. RTD-specific CSS is removed, while the announcement page now uses Shibuya semantic color tokens in both light and dark modes.
Shibuya 2026.7.12 is licensed under BSD-3-Clause.
Usage
Talos preview: https://sc.talos.nvidia.com/view/home/scratch.akuriparambi_coreai/feature-branches/modelopt-shibuya-doc-theme/docs/build/html/index.html
Testing
nox -N --envdir /tmp/modelopt-shibuya-nox -s docs--fail-on-warning.pre-commit run --files docs/source/conf.py docs/source/_static/custom.css docs/source/_static/announcements.css pyproject.toml uv.lock --show-diff-on-failureBefore your PR is "Ready for review"
Make sure you read and follow Contributor guidelines and your commits are signed (
git commit -s -S).Make sure you read and follow the Security Best Practices (e.g. avoiding hardcoded
trust_remote_code=True,torch.load(..., weights_only=False),pickle, etc.).CONTRIBUTING.md: ✅Additional Information
No source code or public API behavior changes.
Summary by CodeRabbit