docs - sphinx - fail on warnings #949
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
briantist
added
documentation
Codecov Report
@@ Coverage Diff @@
## develop #949 +/- ##
===========================================
- Coverage 81.64% 81.33% -0.32%
===========================================
Files 65 65
Lines 3002 2968 -34
===========================================
- Hits 2451 2414 -37
- Misses 551 554 +3
|
dhuckins
approved these changes
Feb 22, 2023
|
@dhuckins thanks for reviewing this! |
briantist
added a commit
that referenced
this pull request
Mar 6, 2023
* docs - sphinx - fail on warnings * fix invalid line in cert documentation * fix markdown files * pin docutils to fix issue with sphinx
briantist
added a commit
to briantist/hvac
that referenced
this pull request
May 10, 2023
* docs - sphinx - fail on warnings * fix invalid line in cert documentation * fix markdown files * pin docutils to fix issue with sphinx
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.
Resolves #946
The docs build tests don't fail on warnings, and it means we can miss some pretty egregious stuff.
This PR will attempt to fail on warnings, and then fix any outstanding warnings we have so that we're in a good state to catch these things on future PRs.