CI Disable sphinx parallelism in CircleCI doc build #25832
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adrinjalali
reviewed
Mar 13, 2023
Comment on lines
+64
to
+65
| # Disable sphinx parallelism to avoid EOFError or job stalling in CircleCI | ||
| - SPHINX_NUMJOBS: 1 |
There was a problem hiding this comment.
it'd be nice to have it run sequencially on a local machine too though.
glemaitre
approved these changes
Mar 13, 2023
There was a problem hiding this comment.
Looking at the PR merged, it seems that it was the proposal of @thomasjpfan but it got merged before I modify it.
@adrinjalali Since the issue should be related to limited hardware, it could still be nice to be able to run the sphinx with several jobs. You can always ask to set the environment variable for reproducibility.
|
I double-checked in the log that sphinx parallelism was disabled and it is the case indeed ( |
adrinjalali
approved these changes
Mar 13, 2023
|
FWIW it seems the latest doc build passed on main: https://app.circleci.com/pipelines/github/scikit-learn/scikit-learn?branch=main |
Veghit
pushed a commit
to Veghit/scikit-learn
that referenced
this pull request
Apr 15, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference Issues/PRs
#25809 actually did not disable sphinx parallelism as you can see from the
-j2in the build log:I think this is because we do
export SPHINX_NUMJOBS=2in build_tools/circle/build_doc.sh and in the MakefileSPHINX_NUMJOBS ?= 1only happens ifSPHINX_NUMJOBSis not already defined ...What does this implement/fix? Explain your changes.
This is another attempt at disabling sphinx parallelism and see if it gets rid of the timeout and EOFError in CircleCI which seems to happen quite consistently recently, see https://app.circleci.com/pipelines/github/scikit-learn/scikit-learn?branch=main.
cc @glemaitre