Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 6 commits into from
Aug 28, 2024

Conversation

dcherian
Copy link
Contributor

@dcherian dcherian commented Aug 22, 2024

  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 executablebooks/sphinx-remove-toctrees#9)

image

@dcherian dcherian requested a review from keewis August 22, 2024 01:30
@mathause
Copy link
Collaborator

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 dcherian marked this pull request as ready for review August 22, 2024 04:14
@dcherian dcherian added topic-documentation Automation Github bots, testing workflows, release automation labels Aug 22, 2024
@dcherian dcherian changed the title [skip-ci] Try speeding up docs build [skip-ci] Speed up docs build by limiting toctrees Aug 27, 2024
Copy link
Collaborator

@keewis keewis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

@dcherian
Copy link
Contributor Author

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.

@dcherian dcherian enabled auto-merge (squash) August 28, 2024 17:38
@dcherian dcherian merged commit 93af904 into pydata:main Aug 28, 2024
28 checks passed
hollymandel pushed a commit to hollymandel/xarray that referenced this pull request Aug 30, 2024
* [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
dcherian added a commit to dcherian/xarray that referenced this pull request Aug 30, 2024
* 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)
@dcherian dcherian deleted the speedup-sphinx branch August 30, 2024 23:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Automation Github bots, testing workflows, release automation topic-documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants