DEV: Pin pydata-sphinx-theme to 0.5.2.

[rossbar]

Pin pydata-sphinx-theme until pydata/pydata-sphinx-theme#381 is resolved.

Since the environment.yml is used to build the gitpod instance, doc builds in gitpod are currently extremely slow.

[charris]

Thanks Ross.

[jorisvandenbossche]

FYI a 0.6.1 was released with a configuration option to get back the old behaviour of collapsed sidebars.

[mattip]

@jorisvandenbossche what do we have to change? PR welcome ...

[jorisvandenbossche]

That depends on the preferences of the numpy devs, see also scipy/scipy#13843 (comment) with some options.
But the "quickest" fix is to add

html_theme_options = {
  "collapse_navigation": True
}

to conf.py, see https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/configuring.html#configure-the-navigation-depth-and-collapsing-of-the-sidebar

(although I personally think having expandable sections in the sidebar is nice, while the above option would disable that)

[mattip]

I have a faint preference for this option:

Another idea mentioned in pydata/pydata-sphinx-theme#364 would be to make the generated API pages orphans, so they wouldn't appear in the sidebar navigation at all, and can only be reached from the autosummary tables on the page itself (or from a search).

[rossbar]

I just compared the two theme versions in fresh gitpod instances; results of time make html:

pydata-sphinx-theme 0.5.2

real 5m44.923s
user 5m33.404s
sys 0m4.163s

pydata-sphinx-theme 0.6.1 w/ "collapse_navigation": True option:

real 9m56.646s
user 9m27.750s
sys 1m49.793s

0.6.1 w/ the collapse_navigation option is definitely an improvement over 0.6.0 (which was ~45 min per doc build in gitpod), but still seems to be significantly slower than 0.5.2. Note however that this isn't a rigorous benchmark - the increase in system time seems suspicious to me (maybe gitpod throttles resources if you have multiple instances running?).