docs: fail on warnings during sphinx build #1441
Merged
Conversation
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
This is useful when docs aren't included in the toctree and don't show up on RTD.
Codecov Report
@@ Coverage Diff @@
## master #1441 +/- ##
=======================================
Coverage 80.24% 80.24%
=======================================
Files 73 73
Lines 4064 4064
=======================================
Hits 3261 3261
Misses 803 803
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
JohnVillalovos
approved these changes
May 1, 2021
Member
JohnVillalovos
left a comment
JohnVillalovos
left a comment
There was a problem hiding this comment.
I like being strict.
LGTM and Thanks!
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.
I was hesitant to make it this strict first, but realized this is useful when docs aren't included in the toctree and the articles don't show up on RTD, unless users specifically search for those keywords. So we actually had some dead documentation this whole time.
Closes #1370.