Support upcoming Sphinx warning-error changes #1043
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
A series of retry events when publishing can report certain events as warnings. The prospect Sphinx v8.1.x release reworks how warnings can trigger a fail state and `skip_warningiserror` becomes deprecated with these changes. This can cause issues for users who wish to run with warnings-as-failure but may experience publishing issues that can be recovered on during a run. To prevent issues, updating a series of warning messages to be informational messages. Signed-off-by: James Knight <[email protected]>
Updating how named arguments are passed into the Sphinx application instance built for testing. The changes should result in the same implementation, but is being made to prepare for an upcoming change for conditional arguments. Signed-off-by: James Knight <[email protected]>
When building a mock Sphinx application to prepare a logger outside of the context of a Sphinx run, include an `_exception_on_warning` attribute. The upstream Sphinx logging implementation can use this hint to drive what logging filters and is needed to ensure an expected setup. Signed-off-by: James Knight <[email protected]>
Sphinx's development branch has updated it's implementation to no longer generate exceptions on an immediate warning by default [1]. This is desired for this extension's tests so the Sphinx application will enable this capability. In addition, the `skip_warningiserror` call is obsolete. With exception-on-warning enabled, a series of tests need to be updated to operate with a relaxed state; updating. [1]: sphinx-doc/sphinx#12743 Signed-off-by: James Knight <[email protected]>
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.
A series of retry events when publishing can report certain events as warnings. The prospect Sphinx v8.1.x release reworks how warnings can trigger a fail state and
skip_warningiserrorbecomes deprecated with these changes. This can cause issues for users who wish to run with warnings-as-failure but may experience publishing issues that can be recovered on during a run. To prevent issues, updating a series of warning messages to be informational messages.Sphinx has also updated it's implementation to no longer generate exceptions on an immediate warning by default [1]. This is desired for this extension's tests so the Sphinx application will enable this capability. The
skip_warningiserrorcall is obsolete. With exception-on-warning enabled, a series of tests need to be updated to operate with a relaxed state; updating.[1]: sphinx-doc/sphinx#12743