Add escalation of warnings to errors in the build of the Sphinx docs.#155
Merged
mo-lucy-gordon merged 6 commits intoMetOffice:mainfrom Aug 28, 2025
Merged
Conversation
mo-lucy-gordon
approved these changes
Aug 28, 2025
Contributor
mo-lucy-gordon
left a comment
There was a problem hiding this comment.
This looks like a good change, can't see any issues
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.
Description
I've added flags to the build-docs workflow to catch build warnings produced by the Sphinx build. The flags do the following:
There is also a small fix to the workflow syntax to make sure the branch checked out by the workflow is the submitting ref (e.g. the branch for the PR or main on merge)
Linked issues
Closes #154
Developer tags
Type of change
How has this been tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
Checklist:
Reasoning on why any of the above boxes have not been checked
Review Checks (To be filled in by the reviewer/s)