many problems building against main

[drammock]

I just built my site locally against current main, and this is what I get:

• dark-mode switcher doesn't work at all (and looks weird)
• version dropdown doesn't work (I can sorta see it responding to the click, but the list of versions doesn't show)
• top nav shows up in left sidebar
• possibly more is broken, didn't look beyond that

This build was done as a make clean && make so I don't think it can have been interference from cruft from a previous build. I'll try to make time to comb through the recently-merged changes soon to figure out what is going on here. It is really strange/worrisome to me that the PST dev docs look fine but downstream user docs can be so badly broken.

[tupui]

Did you also notice slowdown to build the doc itself? Locally I can still build SciPy's doc, but on the CI now I am timing out all the time. I opened #855

[choldgraf]

Just a note that if you think this issue should block a release (as it seems this should), add the block-release label. I don't have much time to put into this for the next few weeks so it would be helpful if others can help keep on top of this

[drammock]

@choldgraf sorry, I forgot about block-release. Added.

@tupui I don't recall a slowdown, but I often kick off the build in a terminal and then do something else for a while.

FWIW, this happened when head was at 703318d and it went away when rolling back to f8e1794 (the immediately previous commit) so it's fairly clear where to look for the genesis of the problem --- though it's possible that subsequent changes on main have already fixed it, I haven't had the time to check yet as I'm trying to push out my own (overdue) release.

[choldgraf]

Any progress on figuring out the root cause analysis? It would be much easier to improve things if we knew specifically what was going wrong.

[drammock]

Any progress on figuring out the root cause analysis? It would be much easier to improve things if we knew specifically what was going wrong.

I'm just coming back to this today. Stay tuned.

[drammock]

I had way less time to work on this today as I hoped. Here is what I can report:

• when using nox -fb none so that pydata-sphinx-theme docs will build in my local env (the one used when building MNE-Python docs), the pydata docs still look OK.
• for some reason the div class="sidebar-header-items sidebar-primary__section" node that is supposed to get a display=none from the media query is simply not seeing that rule.
• there are no rules in MNE-Python's custom CSS that target that node's classes.

TLDR: so far I'm stumped. More tomorrow.

[drammock]

ok, I've found the problem. MNE-Python docs are missing a div node that is present for PST docs. specifically:

├─ div class="bd-container container-xl"
  └─ div class="bd-container__inner row"
    └─ div class="bd-sidebar-primary bd-sidebar"  <--- this one is missing
      └─ div class="sidebar-header-items sidebar-primary__section"

Now, to figure out why.

[drammock]

eureka! It's because I had customized our _templates/layout.html with a quick-and-dirty workaround for #854 (a few days before #854 was reported) --- and then promptly forgotten that I'd done it.

That workaround required basically copy-pasting the theme's entire layout.html (see here) instead of the previous, more concise extends-plus-super()-based approach we had before (see here). So then this line:

pydata-sphinx-theme/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html

Line 84 in 18715ff

<div class="bd-sidebar-primary bd-sidebar{% if not sidebars %} hide-on-wide{% endif %}">

...which was added in #834 isn't present in my customized layout.html, so the CSS selector that hides the sidebar items fails.

Closing now, and hoping that one of us finds time to fix #854 soon :)