Allow letting the docs build to fail with servedocs()#176
Merged
Conversation
Previously `servedocs()` would exit whenever the docs failed to build, and it can be annoying to always restart it on errors. Now when building the docs fails a special status will be set on the `SimpleWatcher` which will get `serve_file()` to return a custom error page (which will be reloaded automatically when the docs build again).
Contributor
Author
|
(gentle bump) |
tlienart
approved these changes
Apr 9, 2024
Collaborator
tlienart
left a comment
tlienart
left a comment
There was a problem hiding this comment.
thanks a lot for this and sorry for the delay (struggling with maintainers duty these days..), PR lgtm, I'll do a minor release soonish
Contributor
Author
|
No worries, thanks for merging it :) |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Previously
servedocs()would exit whenever the docs failed to build, and it can be annoying to always restart it on errors. Now when building the docs fails a special status will be set on theSimpleWatcherwhich will getserve_file()to return a custom error page (which will be reloaded automatically when the docs build again).This is what the error page looks like:
