Treat sphinx warnings as errors - #669
Merged
Merged
Conversation
For now, we just want to treat, non-docstring related warnings as errors.
Member
Author
There was a problem hiding this comment.
Yes, this is pretty darn awful, but we have too much docstring related debt right now (sadly, I don't have one week to spend fixing all those docstring related issues).
I want to start with at least fix non-docstring related issues and treating those issues as fatal going forward.
Kami
changed the title
Member
Author
|
Alright, merged. Going forward, all the sphinx warnings are not treated as error and will fail the build - this means they need to be fixed before merging changes into trunk. |
This file contains hidden or 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
2 participants
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.
This pull request re-enabled features which treats sphinx warnings as errors which cause build to fail.
We had this feature enabled in the past, but at some point we disabled it (probably when we enabled sphinx auto doc) so we accumulated a bunch of documentation and docstring related debts since warnings didn't cause build to fail and people simply ignored those issues.
Future TODO (up for grabs):
more than one target found for cross-referencemessages)