Treat warnings as errors only on CI - #122
Merged
Merged
Conversation
amotl
commented
Dec 23, 2025
| SPHINXBUILD = $(ENV_DIR)/bin/sphinx-build | ||
| SPHINXAUTOBUILD = $(ENV_DIR)/bin/sphinx-autobuild | ||
| AUTOBUILD_OPTS = --watch $(TOP_DIR) --re-ignore '^(?!.+\.(?:rst|md|mmd|html|css|js|py|conf)$$)' --open-browser --delay 0 --jobs auto | ||
| AUTOBUILD_OPTS = --watch $(TOP_DIR) --re-ignore '^(?!.+\.(?:rst|md|mmd|html|css|js|py|conf)$$)' --open-browser --delay 0 |
Contributor
Author
There was a problem hiding this comment.
This is just a little fix where --jobs auto was defined redundantly: It is already defined per SPHINX_OPTS.
amotl
commented
Dec 23, 2025
Comment on lines
-56
to
+57
| SPHINX_OPTS = -W -n --jobs auto | ||
| SPHINX_OPTS_CI = --keep-going | ||
| SPHINX_OPTS = -n --jobs auto | ||
| SPHINX_OPTS_CI = -W --keep-going |
Contributor
Author
There was a problem hiding this comment.
This effectively switches the -W option to SPHINX_OPTS_CI, so it is no longer used in authoring mode.
Contributor
Author
|
I've validated the patch by bumping downstream cratedb-guide's |
Only use it in CI workflows.
amotl
force-pushed
the
treat-warnings-as-errors-only-on-ci
branch
from
December 23, 2025 22:16
4252e10 to
956185a
Compare
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.
About
Improve authoring ergonomics by not invalidating the incremental build cache on errors that happen easily when editing.
References