pydata_sphinx_theme 0.14.1 breaks current website look

[melissawm]

Building the docs with the newest PyData Sphinx Theme (0.14.1) creates a few inconsistent visual elements, most glaringly the top navbar (note also the accent color):

[ksunden]

The navbar positioning seems to be a function of width of window... wider and it looks perfectly fine, narrower and it gets collapsed into a hamburger menu, but there is the squishy middle where it still does the top bar but makes the right hand items two levels and line breaks the two word headings.

That much does happen with e.g. 0.13.3 (what current docs are built with), but is made more prominent in 0.14 because the search bar is no longer just an icon.

I do agree that the accent color seems to have change, despite having what used to set it in the css:

mpl-sphinx-theme/mpl_sphinx_theme/static/css/style.css

Lines 32 to 34 in 6d13c7b

	#navbar-icon-links .nav-link:hover {
	color: var(--pst-color-primary);
	}

Also darkmode changed from a darker black/grey tone to a blue tone background color

[melissawm]

Sorry I should have mentioned that this happens on a maximized window so I think the issue is there anyway. There will surely be other problems with the new version though, maybe we should collect all of them here?

[jklymak]

Looks like they did this purposefully for accessibility reasons. pydata/pydata-sphinx-theme#1353. I'm not a fan aesthetically, but I don't know the accessibility arguments. Looks like there are new knobs though: pydata/pydata-sphinx-theme#835. See also pydata/pydata-sphinx-theme#835

Probably should pin until someone has a chance to sift through and set the correct settings.

[melissawm]

The pin is there on requirements/doc_requirements.txt but not in environment.yml which is how I found this issue. Is there a plan for keeping those two files synchronized?

[jklymak]

Are you talking about in matplotlib/matplotlib?

[melissawm]

Yes, sorry 😄

[jklymak]

I don't actually see a pin there so not sure what is going on. Maybe pinned on CI?

[ksunden]

https://github.com/matplotlib/matplotlib/blob/a99673c970bc1dac1e54175ed3166e5190c9d793/requirements/doc/doc-requirements.txt#L17

Here is the pin that is used by CI (and builds for releases)

[timhoffm]

There is no out-of-the-box solution for syncing, but we could cobble up a script that does it reasonably well and run that on CI.

Theoretically, version bumps only happen with rarely and no sync was sort of good enough. But we needed quite a bit of pinning recently, so it might be worth to look into this.