Abort Sphinx build on warnings #165
Merged
Conversation
This file contains 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.
-Wis "treat sphinx warnings as errors". For instance, a reference that cannot be resolved is a warning and won't fail the build, otherwise. Locally, the PDF generator produces so much terminal-barf that warnings are often overlooked, despite being rendered in a different color.--keep-goingdoesn't immediately stop on the first error. That is useful in CI, because it shows all the broken things to be fixed. Hopefully, that makes the "fix, commit, push, CI-fail"-cycle shorter.Side note: CI now fails because the underlying
mainbranch currently produces a warning that is fixed in #164.