Execute examples in parallel - #900
Open
AVHopp wants to merge 4 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation example-build pipeline to execute example conversions concurrently, aiming to reduce overall docs build time while keeping the generated toctree structure intact.
Changes:
- Refactors per-example conversion into a dedicated
_convert_example()helper. - Collects all example conversion tasks first, then executes them in parallel via
ThreadPoolExecutor. - Adds a
max_workersparameter to control conversion concurrency.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
AVHopp
force-pushed
the
docs/parallelize_example_execution
branch
from
August 20, 2026 11:01
e23fcc5 to
0268bec
Compare
AVHopp
marked this pull request as draft
August 20, 2026 13:32
AVHopp
force-pushed
the
docs/parallelize_example_execution
branch
from
August 31, 2026 07:59
0268bec to
dfdf30d
Compare
AVHopp
force-pushed
the
docs/parallelize_example_execution
branch
from
August 31, 2026 08:13
dfdf30d to
58fa424
Compare
AVHopp
force-pushed
the
docs/parallelize_example_execution
branch
2 times, most recently
from
August 31, 2026 11:49
74f7bdc to
8791128
Compare
AVHopp
force-pushed
the
docs/parallelize_example_execution
branch
from
August 31, 2026 12:14
8791128 to
0e3f154
Compare
AVHopp
force-pushed
the
docs/parallelize_example_execution
branch
from
September 1, 2026 06:42
0e3f154 to
a6a41bc
Compare
AVHopp
force-pushed
the
docs/parallelize_example_execution
branch
from
September 1, 2026 06:43
a6a41bc to
6b5b791
Compare
AVHopp
force-pushed
the
docs/parallelize_example_execution
branch
2 times, most recently
from
September 1, 2026 14:42
0ed859a to
68ea474
Compare
AVHopp
marked this pull request as ready for review
September 1, 2026 15:45
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
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.
This PR makes the doc building execute the examples in parallel, significantly speeding up the overall execution.
This has been achieved as follows:
_convert_example)Important: While this always improves the running time, it is hard to estimate by how much since this seems to depend on how much work load is currently done in other CI tests. I've seen the full doc building job to complete between 8 and 14 minutes, which is a speed-up in any case.
Compiled docs: See https://emdgroup.github.io/baybe/latest/ (compiled September 1st, around 5:30 PM). PLEASE TAKE A LOOK HERE at the examples - I looked at some of them and everything looked as expected, but please double-check that your favourite examples look like you expect them to look.
Stack created with GitHub Stacks CLI • Give Feedback 💬