Sphinx: add --keep-going when fail_on_warning is true #7251
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
The option was added in sphinx 1.8, and we only add it if the user sets `fail_on_warning: true`. https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-keep-going Closes #7240
humitos
reviewed
Jul 1, 2020
| @@ -240,7 +240,7 @@ def build(self): | |||
| if self._force: | |||
| build_command.append('-E') | |||
| if self.config.sphinx.fail_on_warning: | |||
| build_command.append('-W') | |||
| build_command.extend(['-W', '--keep-going']) | |||
There was a problem hiding this comment.
Do you think it's better to add them together here? Or it worth to have another config in our config file for the --keep-going?
There was a problem hiding this comment.
I don't see a reason where users don't want these options together
humitos
approved these changes
Jul 8, 2020
6 tasks
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.
The option was added in sphinx 1.8,
and we only add it if the user sets
fail_on_warning: true.https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-keep-going
Closes #7240