[skip-ci] Speed up docs build by limiting toctrees #9395
Conversation
|
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
added
topic-documentation
Automation
dcherian
changed the title
There was a problem hiding this comment.
just so I understand: with sphinx-remove-toctrees we remove the links to the generated API pages. What does navigation_depth=2 do in addition to that? As far as I can tell, we don't nest deeper than 2, anyways (which means this shouldn't change anything, and thus doesn't have to be fixed before merging).
Other than that this looks good to me, though, especially the changes to the latest versions.
Edit: actually, is there a reason why you went with pip? sphinx-remove-toctrees has a package on conda-forge (or at least, a feedstock)
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
Didn't see that! will fix. |
* [skip-ci] Try speeding up docs build Following https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/performance.html * bump to 3.12 * [skip-ci] latest mamba * Use mamba * revert navigation_depth change
* main: Accessibility: Add keyboard handling for XArray HTML view (pydata#9412) [pre-commit.ci] pre-commit autoupdate (pydata#9316) [skip-ci] Speed up docs build by limiting toctrees (pydata#9395) fix the failing `pre-commit.ci` runs (pydata#9411) Update benchmarks.yml (pydata#9406) GroupBy(multiple groupers) (pydata#9372) Encode/decode property tests use variables() (pydata#9401)
3 participants
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 executablebooks/sphinx-remove-toctrees#9)