Skip to content

Improve html repr in dark mode (Jupyterlab + Xarray docs) #10353

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

Merged
merged 3 commits into from
May 30, 2025
Merged

Improve html repr in dark mode (Jupyterlab + Xarray docs) #10353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
46a0d3c
html repr fallback colors from pydata sphinx theme
benbovy May 26, 2025
ffc952d
doc: fix html reprs pydata sphinx theme dark mode
benbovy May 26, 2025
5627d09
do not lighten or or darken too much row b-color
benbovy May 26, 2025
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
8 changes: 8 additions & 0 deletions doc/_static/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,11 @@ html[data-theme="dark"] .sd-card img[src*=".svg"] {
.bd-content .sd-card .sd-card-body {
background-color: unset !important;
}

/* workaround Pydata Sphinx theme using light colors for widget cell outputs in dark-mode */
/* works for many widgets but not for Xarray html reprs */
/* https://github.com/pydata/pydata-sphinx-theme/issues/2189 */
html[data-theme="dark"] div.cell_output .text_html:has(div.xr-wrap) {
background-color: var(--pst-color-on-background) !important;
color: var(--pst-color-text-base) !important;
}
Comment on lines +51 to +54
Copy link
Member Author

Choose a reason for hiding this comment

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

This workaround is only for Xarray's documentation.

Xarray object reprs won't be better displayed in 3rd-party documentations using Pydata Sphinx Theme until pydata/pydata-sphinx-theme#2189 is fixed.

80 changes: 64 additions & 16 deletions xarray/static/css/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,76 @@
*/

:root {
--xr-font-color0: var(--jp-content-font-color0, rgba(0, 0, 0, 1));
--xr-font-color2: var(--jp-content-font-color2, rgba(0, 0, 0, 0.54));
--xr-font-color3: var(--jp-content-font-color3, rgba(0, 0, 0, 0.38));
--xr-border-color: var(--jp-border-color2, #e0e0e0);
--xr-disabled-color: var(--jp-layout-color3, #bdbdbd);
--xr-background-color: var(--jp-layout-color0, white);
--xr-background-color-row-even: var(--jp-layout-color1, white);
--xr-background-color-row-odd: var(--jp-layout-color2, #eeeeee);
--xr-font-color0: var(
--jp-content-font-color0,
var(--pst-color-text-base rgba(0, 0, 0, 1))
);
--xr-font-color2: var(
--jp-content-font-color2,
var(--pst-color-text-base, rgba(0, 0, 0, 0.54))
);
--xr-font-color3: var(
--jp-content-font-color3,
var(--pst-color-text-base, rgba(0, 0, 0, 0.38))
);
--xr-border-color: var(
--jp-border-color2,
hsl(from var(--pst-color-on-background, white) h s calc(l - 10))
);
--xr-disabled-color: var(
--jp-layout-color3,
hsl(from var(--pst-color-on-background, white) h s calc(l - 40))
);
--xr-background-color: var(
--jp-layout-color0,
var(--pst-color-on-background, white)
);
--xr-background-color-row-even: var(
--jp-layout-color1,
hsl(from var(--pst-color-on-background, white) h s calc(l - 5))
);
--xr-background-color-row-odd: var(
--jp-layout-color2,
hsl(from var(--pst-color-on-background, white) h s calc(l - 15))
);
}

html[theme="dark"],
html[data-theme="dark"],
body[data-theme="dark"],
body.vscode-dark {
--xr-font-color0: rgba(255, 255, 255, 1);
--xr-font-color2: rgba(255, 255, 255, 0.54);
--xr-font-color3: rgba(255, 255, 255, 0.38);
--xr-border-color: #1f1f1f;
--xr-disabled-color: #515151;
--xr-background-color: #111111;
--xr-background-color-row-even: #111111;
--xr-background-color-row-odd: #313131;
--xr-font-color0: var(
--jp-content-font-color0,
var(--pst-color-text-base, rgba(255, 255, 255, 1))
);
--xr-font-color2: var(
--jp-content-font-color2,
var(--pst-color-text-base, rgba(255, 255, 255, 0.54))
);
--xr-font-color3: var(
--jp-content-font-color3,
var(--pst-color-text-base, rgba(255, 255, 255, 0.38))
);
--xr-border-color: var(
--jp-border-color2,
hsl(from var(--pst-color-on-background, #111111) h s calc(l + 10))
);
--xr-disabled-color: var(
--jp-layout-color3,
hsl(from var(--pst-color-on-background, #111111) h s calc(l + 40))
);
--xr-background-color: var(
--jp-layout-color0,
var(--pst-color-on-background, #111111)
);
--xr-background-color-row-even: var(
--jp-layout-color1,
hsl(from var(--pst-color-on-background, #111111) h s calc(l + 5))
);
--xr-background-color-row-odd: var(
--jp-layout-color2,
hsl(from var(--pst-color-on-background, #111111) h s calc(l + 15))
);
}

.xr-wrap {
Expand Down
Loading