DOC: Make sphinx fail the build when --warnings-are-errors is set #24523
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.
xref #22743
We already had an option
--warnings-are-errors
indoc/make.py
, but it was making the doc build cancel after the first warning was found, generating a Python exception. Changed to finish the build, and not raise any error, but exit with 1.Also, when building a single document, ignore the broken reference warnings (they are broken because we don't build the referenced documents).