Docs sidebar is squished

[TomNicholas]

What happened?

Since the v2024.01.0 release yesterday, there seems to be a rendering error in the website - the sidebar is squished up to the left:

[jhamman]

this may be the same issue as here: #8366

[TomNicholas]

This doesn't happen when viewing the docs for the previous release, so something must have changed...

https://docs.xarray.dev/en/v2023.11.0/

[TomNicholas]

This is a bit of a problem - the squishing often makes the sidebar unreadable for me now.

@andersy005 wondering if you have any ideas what might have caused this?

[dcherian]

Probably an upstream bug: https://github.com/pydata/pydata-sphinx-theme

[TomNicholas]

Are we actually using pydata-sphinx-theme? From our docs env it looks like we are just using sphinx-book-theme?

xarray/ci/requirements/doc.yml

Line 35 in 35b7ab1

- sphinx-book-theme >= 0.3.0

[kmuehlbauer]

@TomNicholas AFAIK, sphinx-book-theme depends on pydata-sphinx-theme.

[cdeil]

The browser console shows this pydata-sphinx-theme.js error:

Uncaught TypeError: Cannot read properties of null (reading 'classList')
at HTMLDocument.T (pydata-sphinx-theme.js:570:5)

Probably needs someone familiar with your docs and https://github.com/pydata/pydata-sphinx-theme to track down the root cause and possible fix.

[keewis]

I think the reason is the upgrade of sphinx-book-theme from 1.0.1 to 1.1.0. Not sure what exactly the cause is, but we can work around this by pinning sphinx-book-theme for now.

Edit: funnily enough, pint, which basically copied and adapted our setup, doesn't appear to have this issue.

[TomNicholas]

Whatever the cause of the problem, pinning sphinx-book-theme to 1.0.1 seems to fix it temporarily (see #8632), so I will merge that and re-release, but leave this issue open until we can un-pin.