Thanks to visit codestin.com
Credit goes to github.com

Skip to content

MNT Removes parallel sphinx build by default #23492

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Jun 14, 2022
Merged

MNT Removes parallel sphinx build by default #23492

merged 3 commits into from
Jun 14, 2022

Conversation

thomasjpfan
Copy link
Member

Sphinx building in parallel was disabled for versions < 4.4. With sphinx>4.4, it was re-enabled, but it leads to the build freezing.

This PR removes -j auto and enables it only on the CI for doc building.

@thomasjpfan thomasjpfan marked this pull request as ready for review May 30, 2022 22:36
thomasjpfan
thomasjpfan commented May 30, 2022
View reviewed changes
build_tools/circle/build_doc.sh Outdated
@@ -130,7 +130,7 @@ else
make_args=html
fi

make_args="SPHINXOPTS=-T $make_args" # show full traceback on exception
make_args="SPHINXOPTS=-j2 $make_args"
Copy link
Member Author

Choose a reason for hiding this comment

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

The -T is already configured by default in the Makefile:

scikit-learn/doc/Makefile

Lines 16 to 17 in effdd6e

ALLSPHINXOPTS = -T -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS)\
$(EXAMPLES_PATTERN_OPTS) .

@thomasjpfan thomasjpfan mentioned this pull request May 30, 2022
Merged
@thomasjpfan thomasjpfan added Quick Review For PRs that are quick to review Documentation labels Jun 3, 2022
@lesteve
Copy link
Member

lesteve commented Jun 9, 2022

It seems like you have some changes from the CircleCI hosting PR 😉

Out of curiosity, you see the full build freeze on your machine when running the examples?

@thomasjpfan thomasjpfan force-pushed the remove_auto_sphinx branch from 57d92b6 to 437012e Compare June 9, 2022 13:44
@thomasjpfan
Copy link
Member Author

thomasjpfan commented Jun 9, 2022 •
edited by lesteve
Loading

Out of curiosity, you see the full build freeze on your machine when running the examples?

It freezes it without building the examples. Specifically it freezes on "waiting for workers..." after "reading sources..."

reading sources... [100%] whats_new .. whats_new/v1.2
waiting for workers...

Note we saw this during a debug session with a contributor during a contributor meeting.

@lesteve
Copy link
Member

lesteve commented Jun 10, 2022

I tried to run make clean html-noplot on my machine:

  • with -j auto: 1 min 30s
  • without -j auto: 2 min 30s

It does seem like -j auto speeds things up a little bit for html-noplot. I don't think this is that crucial though ...

@thomasjpfan
Copy link
Member Author

I don't think this is that crucial though ...

I think it's important to keep build times low by default. With 89a5c31 (#23492), parallelism is disabled for OSX, but is still on for all other platforms.

@lesteve
Copy link
Member

lesteve commented Jun 10, 2022

Thanks! I'll wait a bit and merge if noone complaints.

In an ideal world, somebody would try to reproduce and report to sphinx but this is definitely low-priority ...

@lesteve
Copy link
Member

lesteve commented Jun 14, 2022

Nobody complained, so merging this one!

@lesteve lesteve merged commit bb0ea58 into scikit-learn:main Jun 14, 2022
ogrisel pushed a commit to ogrisel/scikit-learn that referenced this pull request Jul 11, 2022
@thomasjpfan @ogrisel
MNT Removes parallel sphinx build by default on OSX (scikit-learn#23492)
b4dcb35
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Aug 4, 2022
@thomasjpfan @glemaitre
MNT Removes parallel sphinx build by default on OSX (scikit-learn#23492)
7f9de44
glemaitre pushed a commit that referenced this pull request Aug 5, 2022
@thomasjpfan @glemaitre
MNT Removes parallel sphinx build by default on OSX (#23492)
3cc6018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lesteve lesteve lesteve approved these changes

Assignees
No one assigned
Labels
Documentation Quick Review For PRs that are quick to review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@thomasjpfan @lesteve