Treat sphinx warnings as errors #4
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
samsrabin
added a commit
to samsrabin/CTSM
that referenced
this pull request
Oct 8, 2024
* Treats Sphinx warnings as errors (see also PR at ESMCI/doc-builder#4) * Points at my Docker container, which includes Python package needed for mdinclude in .rst files
7 tasks
|
@billsacks Do you think we could discuss this at some point soon? |
|
Sure, I'd be happy to talk with you about this. Thurs afternoon or sometime Friday would be best for me this week. I definitely like this idea! |
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.
This PR makes it so that, by default, the sphinx command called (via the Makefile) by
build_docstreats warnings as errors. The build will still complete, but the exit code will be 1 instead of 0, and the "The HTML pages are in" message won't appear.Users can disable this behavior with the new
-w/--warnings-as-warningsflag.Tested in the CTSM repo with deliberately-bad restructuredText (invalid references) with flags:
-d,-d -w,-w, and neither. Additional independent testing would be smart, I think, as I was using a custom Docker container for the-dtests.