Skip to content

Table of contents overlapping content #10223

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.

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

Closed
subbuballa opened this issue Apr 12, 2025 · 1 comment
Closed

Table of contents overlapping content #10223

subbuballa opened this issue Apr 12, 2025 · 1 comment
Labels
needs triage Issue that has not been reviewed by xarray team member topic-documentation

Comments

@subbuballa
Copy link

What is your issue?

Table of contents is overlapping content on the documentation pages. Screen shot attached

Image

@subbuballa subbuballa added the needs triage Issue that has not been reviewed by xarray team member label Apr 12, 2025
@scottyhq
Copy link
Contributor

scottyhq commented Apr 17, 2025

Thanks for pointing this out. Will have to dig into the cause, but confirming that I notice the same behavior on Chrome and Safari. I quickly looked at past tagged versions and noticed that it's been this way for quite a while!

Overlapping right sidebar on narrow windows:
https://docs.xarray.dev/en/v2023.03.0/getting-started-guide/quick-overview.html

Well-behaved sidebar:
https://docs.xarray.dev/en/v2023.02.0/getting-started-guide/quick-overview.html

Adding some steps I'm following below to diagnose this in case it's helpful in the future

Since we know something changed between those versions we can look at the diff:
v2023.02.0...v2023.03.0#diff-ee67cb3ebad7bc79dddc558d9e0d4b1d96f2562e49f12a3d9f2962e1e9717154

Seems this happened after the v0.3.0 theme release:
https://github.com/executablebooks/sphinx-book-theme/releases/tag/v0.3.0

This release modifies the HTML structure of some of the major theme sections (in particular, the sidebar and top-bar).
If you had custom CSS or JavaScript that assumed a particular HTML structure, double-check that it still behaves the same way, as you may need to adjust things for the new structure.

So... maybe coming from custom css here https://github.com/pydata/xarray/blob/main/doc/_static/style.css

Note: duplicate of #8366, and possibly related to other observed sidebar squishing coming from changes to the https://github.com/executablebooks/sphinx-book-theme theme over time (#8619)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs triage Issue that has not been reviewed by xarray team member topic-documentation
Projects
None yet
Development

No branches or pull requests

3 participants