Repository navigation
Pin breathe<5 in the Docs workflow - #168
Merged
Merged
Conversation
* Pin breathe<5 in docs workflow Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> * Explain the breathe pin in docs.yml Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 5 <noreply@anthropic.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.
Summary
The
Docsworkflow will fail on the next push tomain.docs.ymlinstallssphinxandbreatheunpinned, so it now picks upbreathe 5.0.0(released 2026-09-21, after this repo's last Docs run), which crashes while rendering the Fortran API page. Pinsbreathe<5until that is fixed upstream.Changes
docs.yml:pip install sphinx breathe→pip install sphinx "breathe<5", with a one-line comment explaining whyThe crash is inside
breathe, not CEA (Sphinx 9.1.0):docs.ymlonly triggers on push tomain, so PR checks will not exercise this change. When the build fails thedeployjob is skipped, so the docs site silently stops updating.Testing
mainpush after 2026-09-21; after it, the Docs run on forkmainpassed end to end (build and deploy): https://github.com/djkees/cea/actions/runs/36164575747breathe 4.36.0with Sphinx 9.1.0 and "Build Sphinx HTML" reportedbuild succeeded.Compatibility / Numerical behavior
Drafted with Claude's assistance.
breathe 5.0.0was released 2026-09-21T18:50Z; this repo's last Docs run (2026-09-21T14:21Z) predates it, so upstream has not yet hit the failure.breathe-4.36.0,sphinx-9.1.0) and thebuild succeededline, and confirmed the run's overall conclusion wassuccess, rather than relying on job status alone.docs.yml(git diff upstream/main..HEAD).🤖 Generated with Claude Code