Docs: Fix xarray Dataset double-rendering in MkDocs#100
Draft
Docs: Fix xarray Dataset double-rendering in MkDocs#100
Conversation
Co-authored-by: eeholmes <2545978+eeholmes@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] [DOCS-123] Improve xarray output rendering in Jupyter notebook
Docs: Fix xarray Dataset double-rendering in MkDocs
Mar 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In the rendered docs,
plan.open_dataset()output displayed both the plain-text fallback and the interactive HTML repr simultaneously (before, below):Root cause: xarray embeds a
<style>block in its HTML repr to hide.xr-text-repr-fallbackand show.xr-wrap. The MkDocs Material theme's<pre>rules have higher specificity than xarray's bare.xr-text-repr-fallback { display: none }, so the text fallback leaks through. Thexr-wrapdiv shows correctly because xarray uses!importantthere, but not on the fallback.Fix —
docs/stylesheets/extra.css:.md-content .xr-text-repr-fallback { display: none !important }to win the specificity battle against the Material theme'sprerules.md-content .xr-wrap { display: block !important }as an explicit guard--xr-*color variables to MkDocs Material equivalents (--md-default-fg-color,--md-code-bg-color, etc.) — xarray's CSS expects Jupyter's--jp-*variables which are absent in MkDocs, so without this the widget renders with incorrect colors in both light and dark modeAfter the fix, only the interactive collapsible xarray widget is shown, matching the Jupyter notebook experience.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.