search

pydata / xarray

N-D labeled arrays and datasets in Python
https://xarray.dev
Apache License 2.0
3.62k stars 1.09k forks source link

[skip-ci] Speed up docs build by limiting toctrees #9395

Closed dcherian closed 2 months ago

dcherian commented 3 months ago
  1. Following https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/performance.html
  2. Bumpy to python 3.12 and latest mamba hoping for more speed

3-5X speedup by removing a bunch of links from the API reference entry in the sidebar.

EDIT: apparently the below is fixed now (https://xray--9395.org.readthedocs.build/en/9395/api.html) ~I don't understand why the following are left (probably https://github.com/executablebooks/sphinx-remove-toctrees/issues/9)~

image
mathause commented 3 months ago

We could also try to installing the dependecies with pip (now that cartopy is pip installable). I saw some speedup with that for my projects.

dcherian commented 2 months ago

What does navigation_depth=2 do in addition to that?

Blindly following https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/performance.html and https://sphinx-theme.readthedocs.io/en/latest/configuring.html#toc-options

sphinx-remove-toctrees has a package on conda-forge

Didn't see that! will fix.