Skip to content

Update documentation theme to Shibuya - #2242

Open
realAsma wants to merge 1 commit into
mainfrom
asma/shibuya-doc-theme
Open

Update documentation theme to Shibuya#2242
realAsma wants to merge 1 commit into
mainfrom
asma/shibuya-doc-theme

Conversation

@realAsma

@realAsma realAsma commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

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

html_theme = "shibuya"
html_theme_options = {
    "accent_color": "green",
    "color_mode": "auto",
    "dark_code": True,
    "globaltoc_expand_depth": 1,
}

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
    • Sphinx 9.1 built all 411 pages successfully with --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-failure
    • All applicable hooks passed.
  • Verified generated HTML loads Shibuya assets, declares the green accent, includes automatic light/dark mode logic, and includes the custom theme-token CSS.

Before 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.).

  • Is this change backward compatible?: ✅
  • If you copied code from any other sources or added a new PIP dependency, did you follow guidance in CONTRIBUTING.md: ✅
  • Did you write any new necessary tests?: N/A — documentation theme change covered by the full warning-as-error build.
  • Did you update Changelog?: N/A — documentation presentation change.
  • Did you get Claude approval on this PR?: N/A — focused documentation theme migration.

Additional Information

No source code or public API behavior changes.

Summary by CodeRabbit

  • Documentation
    • Updated the documentation site with the Shibuya theme.
    • Added green theme accents, automatic light/dark mode, and dark code blocks.
    • Improved table-of-contents behavior and refreshed announcement styling.
    • Removed outdated layout and table customization overrides.

Signed-off-by: realAsma <akuriparambi@nvidia.com>
@realAsma
realAsma requested review from a team as code owners August 24, 2026 23:06
@coderabbitai

coderabbitai Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

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: 0b882727-902b-4030-b16d-afc25714664f

📥 Commits

Reviewing files that changed from the base of the PR and between 73d7784 and 353bcae.

⛔ Files ignored due to path filters (1)
  • uv.lock is excluded by !**/*.lock
📒 Files selected for processing (4)
  • docs/source/_static/announcements.css
  • docs/source/_static/custom.css
  • docs/source/conf.py
  • pyproject.toml

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


📝 Walkthrough

Walkthrough

The documentation site migrated from sphinx_rtd_theme to Shibuya. Theme options now support green accents, automatic light and dark modes, dark code blocks, and Shibuya color tokens across announcement styles.

Changes

Documentation theme migration

Layer / File(s) Summary
Configure Shibuya documentation theme
pyproject.toml, docs/source/conf.py, docs/source/_static/custom.css
The documentation dependency and theme configuration now use Shibuya. Custom styles define NVIDIA green accents and remove superseded layout overrides.
Apply Shibuya tokens to announcements
docs/source/_static/announcements.css
Announcement controls, cards, tags, metadata, separators, and pagination now use Shibuya light and dark theme tokens.

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

Merge Risk: ⚪ Minimal · up to 353bc

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: kevalmorabia97, chenhanyu

🚥 Pre-merge checks | ✅ 6
✅ Passed checks (6 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the primary change: replacing the documentation theme with Shibuya.
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.
Security Anti-Patterns ✅ Passed PASS. The PR changes only documentation CSS/configuration, pyproject.toml, and uv.lock; it adds no modelopt or examples Python changes. The only new dependency is Shibuya 2026.7.12, which the …
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. (3 skipped: 3 unsupported.)

Full details: Security Anti-Patterns

Explanation

PASS. The PR changes only documentation CSS/configuration, pyproject.toml, and uv.lock; it adds no modelopt or examples Python changes. The only new dependency is Shibuya 2026.7.12, which the PR identifies as BSD-3-Clause, a permissive license. The diff adds no torch.load(..., weights_only=False), numpy.load(..., allow_pickle=True), trust_remote_code=True, eval(), exec(), or # nosec usage.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch asma/shibuya-doc-theme

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

@github-actions

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://NVIDIA.github.io/Model-Optimizer/pr-preview/pr-2242/

Built to branch gh-pages at 2026-08-24 23:11 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@codecov

codecov Bot commented Aug 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.42%. Comparing base (73d7784) to head (353bcae).

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     
Flag Coverage Δ
examples-diffusers 20.70% <ø> (ø)
examples-gpt-oss 13.23% <ø> (ø)
examples-hf_ptq 21.47% <ø> (-0.04%) ⬇️
examples-llm_distill 13.30% <ø> (-0.01%) ⬇️
examples-llm_eval 17.07% <ø> (ø)
examples-llm_qat 17.55% <ø> (-0.01%) ⬇️
examples-llm_sparsity 15.88% <ø> (ø)
examples-megatron_bridge 25.66% <ø> (-0.15%) ⬇️
examples-specdec_bench 12.98% <ø> (ø)
examples-speculative_decoding 17.49% <ø> (-0.07%) ⬇️
examples-torch_trt 15.04% <ø> (ø)
gpu 58.45% <ø> (-0.71%) ⬇️
regression 14.89% <ø> (+0.07%) ⬆️
unit 55.67% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

1 participant