-
Notifications
You must be signed in to change notification settings - Fork 161
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
set an exit code in make_doc
#5835
Conversation
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.
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. |
After some experiments, I think that this pull request can be merged, as it improves the behaviour for the main GAP manuals. Concerning more general support for package manuals, i.e., how to detect problems when building a package's documentation (in CI tests), the situation is not obvious: There is the Besides that, changing return values or printed output of |
With this change, the CI tests detect whether errors like broken references occur when the manuals get built.
For that,
Info
output generated by GAPDoc functions to a string,"#W "
,