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

MNT: Pin sphinx to avoid very slow doc build on RTD #11014

Merged
merged 1 commit into from
Nov 10, 2020

Conversation

pllim
Copy link
Member

@pllim pllim commented Nov 9, 2020

Description

This pull request is to see what is causing RTD doc build to take so long.

Also see readthedocs/readthedocs.org#7648 #10807 #10998

Note: Cancelled CI on purpose as I don't think they are needed.

@pllim
Copy link
Member Author

pllim commented Nov 9, 2020

@saimn , I don't see the timing. Is simply adding the extension not enough? Is there something else I need to do? The documentation is pretty bare. https://www.sphinx-doc.org/en/master/usage/extensions/duration.html

@saimn
Copy link
Contributor

saimn commented Nov 9, 2020

Yes, you just need to add the extension, but it doesn't seem to work on RTD (I noticed the same thing in #10795).

@saimn
Copy link
Contributor

saimn commented Nov 9, 2020

Also, having a look at the builds on RTD, I don't see what could have changed on Astropy side to explain the the build takes more than twice longer. 2 weeks ago sphinx-build was taking 500-600 seconds.

@pllim

This comment has been minimized.

@pllim
Copy link
Member Author

pllim commented Nov 10, 2020

I have my suspects...

Older log (faster) New log (slower) This PR log
Build ID 12228280 12305403 12306918
Build date 2020-10-30 2020-11-10 2020-11-10
sphinx-build duration (s) 536 1345 562
Sphinx 3.2.1 3.3.0 3.2.1
Matplotlib font message -- "Matplotlib is building the font cache; this may take a moment." "Matplotlib is building the font cache; this may take a moment."
cached-property 1.5.2 -- --
attrs 20.2.0 20.3.0 20.3.0
kiwisolver 1.2.0 1.3.1 1.3.1
numpy 1.19.3 1.19.4 1.19.4
scipy 1.5.3 1.5.4 1.5.4
sortedcontainers 2.2.2 2.3.0 2.3.0
toml 0.10.1 0.10.2 0.10.2

@pllim
Copy link
Member Author

pllim commented Nov 10, 2020

I think the culprit is Sphinx 3.3.0 (released 2020-11-02) but I don't know if this is Sphinx bug or our sphinx-astropy isn't playing well with new Sphinx release.

@pllim pllim marked this pull request as ready for review November 10, 2020 16:22
@pllim pllim added Bug and removed Experimental labels Nov 10, 2020
@pllim pllim added this to the v4.0.4 milestone Nov 10, 2020
@pllim pllim changed the title EXP: See why doc build so slow MNT: Pin sphinx to avoid very slow doc build on RTD Nov 10, 2020
@pllim pllim requested review from a team and saimn November 10, 2020 16:28
@pllim
Copy link
Member Author

pllim commented Nov 10, 2020

I wonder if I should open an issue over at Sphinx but I wouldn't know how to isolate the problem for them.

Update: Reported to sphinx-doc/sphinx#8403 as Brigitta suggested.

@bsipocz
Copy link
Member

bsipocz commented Nov 10, 2020

Hmm, even just reporting them this table and the logs might be useful enough for them.

(I also wonder whether the mpl font building also has any effects, I recall it was an issue in the past?)

@pllim
Copy link
Member Author

pllim commented Nov 10, 2020

@bsipocz , font building seems to add about 30-ish seconds but definitely was not the cause.

Copy link
Contributor

@saimn saimn left a comment

Choose a reason for hiding this comment

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

Sounds good, thanks @pllim for the investigation !
I guess we could merge this soon ?

@pllim
Copy link
Member Author

pllim commented Nov 10, 2020

I guess we could merge this soon ?

Yes, please!

@saimn saimn merged commit bd23ec2 into astropy:master Nov 10, 2020
@pllim pllim deleted the sphinx-duration branch November 10, 2020 20:59
@pllim pllim mentioned this pull request Nov 12, 2020
bsipocz pushed a commit that referenced this pull request Nov 23, 2020
MNT: Pin sphinx to avoid very slow doc build on RTD
@bsipocz bsipocz modified the milestones: v4.0.4, v4.2 Nov 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants