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

severe performance degradation between 0.5.2 and 0.6.2 #504

Closed
sandrotosi opened this issue Oct 22, 2021 · 4 comments
Closed

severe performance degradation between 0.5.2 and 0.6.2 #504

sandrotosi opened this issue Oct 22, 2021 · 4 comments

Comments

@sandrotosi
Copy link

Hello,
i was building numpy documentation with pydata-sphinx-theme/0.5.2 (which is the version pinned in their requirements.txt), but that's affected by #394 which is fixed in 0.6.2, but when i've upgraded to that version, the build time spiked substantially.

I've run a test with these pydata-sphinx-theme versions, with the time (in mm:ss.00 format) it took to rebuild numpy's doc with each version:

  • 0.5.2: 5:17.99
  • 0.6.2: 25:20.05
  • 0.6.3: 24:53.24
  • 0.7.0: 24:34.35
  • 0.7.1: 24:52.37

as you can see, in using 0.6.2 onward the time is 5x what it was with 0.5.2 (granted, numpy's doc fails with that version, but at the very end of the build process, so that's still relevant), and the only thing changing in this build environment is the pydata-sphinx-theme version used.

I'm wondering if this is something you're aware of and plan to address, or is this a news and maybe some investigation is required?

Thanks,
Sandro

@jorisvandenbossche
Copy link
Member

This is a known issue (see eg numpy/numpy#18789 on the numpy side. For which version of numpy are you trying to build the docs?), with several possible solutions. See #364 for an explanation (and #381).

#492 is improving the documentation about the different options to deal with this, and that also led to a new package (https://github.com/executablebooks/sphinx-remove-toctrees)

@sandrotosi
Copy link
Author

thanks! i was building numpy 1.21.2

@12rambau
Copy link
Collaborator

12rambau commented Jun 3, 2022

As this issue is related to numpy and the underlying problem is dealt with in other issues should we close this one ?

@choldgraf
Copy link
Collaborator

Yep we have made and documented ways around this in this PR:

so I think we can close

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants