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

CI: Test building docs in parallel on Cirrus CI #28244

Closed
wants to merge 1 commit into from

Conversation

scottshambaugh
Copy link
Contributor

@scottshambaugh scottshambaugh commented May 17, 2024

PR summary

Just experimenting for now, curious if this speeds things up

For comparison, this docs build took 20m 11s as a baseline on a single core.
image

PR checklist

@scottshambaugh
Copy link
Contributor Author

scottshambaugh commented May 17, 2024

With 2 cores the time to build the docs dropped to 18m 9s.

image

The errors that caused this failure are:

WARNING: the pydata_sphinx_theme extension is not safe for parallel writing
WARNING: doing serial write

This is the relevant issue: pydata/pydata-sphinx-theme#1643. Some users there reported no problems with setting the parallel_write_unsafe flag to False. Will try that next.

@scottshambaugh
Copy link
Contributor Author

Ok digging into it more, looks like this was talked about in #27658

The parallel unsafe flag was added in pydata/pydata-sphinx-theme#1642, where this was the behavior:

marks the theme as unsafe for parallel_write. This is based on extensive testing of the SciPy docs build, where the API pages were reliably getting the wrong left sidebar TOC when built in parallel, and getting the correct sidebar TOC when built with a single job. After marking the theme as parallel-write-unsafe, the SciPy docs now end up with the correct sidebar on all pages even when building in parallel (i.e. when pages are read in parallel but written serially)

Worth another look when that all gets fixed but closing for now.

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

1 participant