Skip to content

Update documentation theme to Shibuya #2242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
realAsma wants to merge 1 commit into
base: main
Choose a base branch
from
+142 −162
Open

Update documentation theme to Shibuya #2242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 17 additions & 15 deletions docs/source/_static/announcements.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/* Scoped announcement styles for the Sphinx RTD theme. */
/* Scoped announcement styles using Shibuya's light and dark color tokens. */

#announcements > h1,
#announcements > p,
Expand All @@ -13,11 +13,11 @@
}

.announcement-toolbar {
border: 1px solid #d6d8dc;
border: 1px solid var(--sy-c-border);
border-radius: 4px;
margin: 1.5rem 0;
padding: 1rem;
background: #f8f9fb;
background: var(--sy-c-background);
}

.announcement-search-label {
Expand All @@ -30,8 +30,10 @@
box-sizing: border-box;
width: 100%;
padding: 0.55rem 0.65rem;
border: 1px solid #b8bdc6;
border: 1px solid var(--sy-c-border);
border-radius: 4px;
background: var(--sy-c-background);
color: var(--sy-c-text);
font-size: 1rem;
}

Expand All @@ -43,11 +45,11 @@
}

.announcement-tag {
border: 1px solid #9aa1ad;
border: 1px solid var(--sy-c-border);
border-radius: 999px;
padding: 0.28rem 0.65rem;
background: #fff;
color: #2f343d;
background: var(--sy-c-background);
color: var(--sy-c-text);
cursor: pointer;
font-size: 0.86rem;
}
Expand All @@ -67,7 +69,7 @@
}

.announcement-card {
border-bottom: 1px solid #d6d8dc;
border-bottom: 1px solid var(--sy-c-border);
padding: 0 0 1rem;
}

Expand All @@ -86,7 +88,7 @@
}

.announcement-card-meta {
color: #6b7280;
color: var(--sy-c-light);
font-size: 0.85rem;
}

Expand All @@ -97,9 +99,9 @@
}

.announcement-card-tags span {
border: 1px solid #d6d8dc;
border: 1px solid var(--sy-c-border);
border-radius: 999px;
color: #4b5563;
color: var(--sy-c-light);
font-size: 0.78rem;
padding: 0.15rem 0.45rem;
}
Expand All @@ -119,10 +121,10 @@
}

.announcement-page-button {
border: 1px solid #9aa1ad;
border: 1px solid var(--sy-c-border);
border-radius: 4px;
background: #fff;
color: #2f343d;
background: var(--sy-c-background);
color: var(--sy-c-text);
cursor: pointer;
padding: 0.35rem 0.7rem;
}
Expand All @@ -133,7 +135,7 @@
}

.announcement-page-status {
color: #4b5563;
color: var(--sy-c-light);
font-size: 0.9rem;
}

Expand Down
32 changes: 4 additions & 28 deletions docs/source/_static/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,13 @@ div.nboutput.container div.output_area.stderr {
visibility: hidden;
}

/* Increase the width of the content area (default 800px) */
div.wy-nav-content {
max-width: 1000px;
/* Use NVIDIA green for Shibuya's primary accent while retaining its accessible green palette. */
html[data-accent-color="green"] {
--accent-9: #76b900;
--accent-a9: rgb(118 185 0 / 81%);
}

/* Show a `$` sign before bash code-blocks */
div.highlight-bash pre::before {
content: "$ ";
}

/* Reduce margin from left sidebar titles */
p.caption {
margin-top: 0.25em !important;
}

/* Reduce padding from left sidebar items */
a.reference.internal {
padding-top: 0;
}

.wy-table-responsive table td,
.wy-table-responsive table th {
white-space: normal;
}

.wy-table-responsive {
margin-bottom: 24px;
max-width: 100%;
overflow: visible;
}

.wy-table-responsive th p {
margin-bottom: unset;
}
7 changes: 5 additions & 2 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,12 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"
html_theme = "shibuya"
html_theme_options = {
"style_external_links": True,
"accent_color": "green",
"color_mode": "auto",
"dark_code": True,
"globaltoc_expand_depth": 1,
}

# Add any paths that contain custom static files (such as style sheets) here,
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ dev-docs = [
"sphinx-autobuild==2025.8.25; python_version >= '3.12'",
"sphinx-copybutton~=0.5.2; python_version >= '3.12'",
"sphinx-inline-tabs==2025.12.21.14; python_version >= '3.12'",
"sphinx-rtd-theme~=3.1.0; python_version >= '3.12'",
"shibuya~=2026.7.0; python_version >= '3.12'",
"sphinx-togglebutton~=0.4.0; python_version >= '3.12'",
]
dev-test = [
Expand Down
Loading
Loading