Added -keep-going flag to build docs #3140
Merged
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
MR for issue #3132.
Added the
--keep-going
flag to sphinx-build documentation inbuild-docs.sh
(and by extensionmake build-docs
.Because all warnings are treated as errors the build will stop if any warnings happens, with this flag the build will still finish despite all the warnings turned errors.
This will hopefully make it a little less for contributors to worry about.
Development notes
All that was changes was the added flag
--keep-going
.It's been tested by building the documentation using
make build-docs
with and without the flag.With the added flag the build will still finish despite any warnings turned errors.
Checklist
RELEASE.md
file