Fix failing Read the Docs builds: raise myst-nb execution timeout#495
Merged
Conversation
The logo animation notebook (docs/source/logo.md) renders 360 frames and encodes them with libvpx-vp9, which takes close to 3 minutes on Read the Docs builders. The 180 s nb_execution_timeout was intermittently exceeded, causing docs builds to fail with CellTimeoutError.
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
1 participant
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.
Problem
Read the Docs builds have been failing intermittently (e.g. build 33082181 for
latest, plus builds for #493 and several PR previews) with:The
logo.mdnotebook regenerates the animated docs logo on every build (the.webmis not committed): it runs aLearner2D, renders 360 PNG frames, and encodes them with libvpx-vp9. On Read the Docs builders this takes close to 3 minutes, so it lands right around the 180 snb_execution_timeout— sometimes passing, sometimes not. The build history shows the same flakiness: identical doc content alternates between success and failure depending on builder speed.Fix
Raise
nb_execution_timeoutfrom 180 to 600 seconds indocs/source/conf.py, giving the logo cell (and any other slow notebook) comfortable headroom without affecting builds that finish quickly.Verification
The RTD build for this PR's preview version should be the real test — all recent failures reproduce only on RTD builders.