set an exit code in make_doc
#5835
Open
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
For that, - redirect the `Info` output generated by GAPDoc functions to a string, - extract the messages that describe warnings; according to frankluebeck/GAPDoc/commit/826c091491438c1f6ba1f330d17914f45b4bd3af, these are the lines starting with `"#W "`, - omit the LaTeX warnings about overfull boxes (I think we do not want to force ourselves to create manuals without these warning), - report failure if the set of remaining warnings is nonempty.
ThomasBreuer
added
kind: enhancement
|
So it reports a failure now. So what is wrong? |
(Funny. I got exit code 0 locally before this change.)
|
It shows a lot of warnings about unresolved references. But those all come from run 1, were they are to be expected (we need to build the manual twice precisely to deal with those). Perhaps run 1 ought to be excluded from this? |
This way, create the documentation w.r.t. the installed GAP without private packages; this is useful for debugging.
(but print it for both runs, as in earlier times)
|
This is more subtle than I had thought. |
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.
With this change, the CI tests detect whether errors like broken references occur when the manuals get built.
For that,
Infooutput generated by GAPDoc functions to a string,"#W ",