[collab] Sync build-tool pins with environment.yml to fix weekly execution check#916
Merged
Conversation
The weekly Colab execution check builds with `-W --keep-going`, so any warning fails the build. The hand-maintained pip install in collab.yml had drifted from environment.yml, producing two config-compat warnings that failed the build every week (no notebook actually fails to execute): - quantecon-book-theme==0.8.2 predates the `sticky_contents` theme option -> "unsupported theme option 'sticky_contents' given" - unpinned sphinx-exercise (latest) no longer registers `exercise_style` -> "unknown config value 'exercise_style' in override, ignoring" Pin the build tools to the same versions environment.yml uses (which ci.yml builds against cleanly), keeping the explicit list so the Colab runtime image's scientific stack is preserved. Fixes #905 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the weekly Google Colab execution-check workflow to use the same documentation build-tool versions as environment.yml, preventing Sphinx/Jupyter Book config warnings from failing the -W --keep-going build.
Changes:
- Align
collab.ymlpip-installed Jupyter Book/Sphinx tooling versions withenvironment.yml(notablyquantecon-book-theme==0.21.0andsphinx-exercise==1.2.1). - Add explicit pins for previously unpinned Sphinx extensions to reduce config-compat drift.
📖 Netlify Preview Ready!Preview URL: https://pr-916--sunny-cactus-210e3e.netlify.app Commit: Build Info
|
2 tasks
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
What this fixes
The weekly Google Colab execution check (collab.yml) has been failing every week (issue #905, and identically for the prior ~6 weeks). Despite the auto-generated "execution failure" title, no notebook actually fails to execute — every executed notebook succeeds and the
_build/html/reportsartifact is empty.The build runs with
-W --keep-going, so any warning is fatal. The hand-maintained pip install incollab.ymlhad drifted far behind environment.yml, producing two config-compat warnings that failed the build:unsupported theme option 'sticky_contents' givenquantecon-book-theme==0.8.2predates thesticky_contentsoption (added in theme 0.17.1)unknown config value 'exercise_style' in override, ignoringsphinx-exerciseresolved to a version that no longer registersexercise_styleThe regular
ci.ymlbuild — which uses the correctenvironment.ymlversions — passes on main, confirming the book is healthy and the problem is isolated to this workflow's dependency install.The change
Pin the build tools in
collab.ymlto the same versionsenvironment.ymluses (and thatci.ymlbuilds against cleanly). The list is kept explicit rather than switching topip install -r requirements.txt, since the whole point of this job is to layer the build tools on top of the Colabruntime:latestscientific stack without clobbering its pinned numpy/scipy/jax/etc.==1.0.3>=1.0.4post1,<2.0==0.8.2==0.21.0==0.3.0==0.6.0==0.2.7==0.3.0==1.3.0==1.5.0==0.3.2==0.4.5==0.4.0==1.2.1==1.1.0Pinning
quantecon-book-theme==0.21.0clears thesticky_contentswarning andsphinx-exercise==1.2.1clears theexercise_stylewarning.Follow-up
This drift will recur unless build-tool versions are kept in sync. Worth having dependency bumps (e.g. the recent #896) also touch
collab.yml, or centralizing these versions.Fixes #905
🤖 Generated with Claude Code