Turn on warnings as error option for sphinx build #409
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
psobolewskiPhD
pushed a commit
that referenced
this pull request
Apr 21, 2024
# References and relevant issues Towards #409 # Description Fixes one broken link in the magicgui how-to, and one warning about an ambiguous reference in the app model docs.
melissawm
force-pushed
the
sphinx-warnings
branch
from
0adfa1e to
ee3795c
Compare
melissawm
force-pushed
the
sphinx-warnings
branch
from
ee3795c to
8762a03
Compare
Also fixes some whitespace.
github-actions
bot
added
the
documentation
DragaDoncila
approved these changes
Aug 1, 2024
There was a problem hiding this comment.
Looks good to me @melissawm! Can't believe we've actually got to this point finally 🎉 Tiny nitpick - the description still said "this PR is in draft mode" so I will update that.
|
@jni and I decided to merge now because then we can merge this into other PRs |
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.
References and relevant issues
--
Description
Turns on
--fail-on-warningoption for Sphinx, so that CI fails the build when we have new warnings.