DM-40495: Add better error reporting of linkcheck failures #836
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
Sphinx's linkcheck target does not summarize errors at the end of the run normally, but it does write the errors into an output.txt file. Move the linkcheck code into Makefile so that we can use shell trickery and display output.txt at the end of the run if the check failed. Add a make help target as the default that displays the available Makefile targets.
Link to the latest scriv documentation to avoid a redirect.
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.
Sphinx's linkcheck target does not summarize errors at the end of the run normally, but it does write the errors into an output.txt file. Move the linkcheck code into Makefile so that we can use shell trickery and display output.txt at the end of the run if the check failed.
Add a make help target as the default that displays the available Makefile targets.