Throw an error early in HTMLWriter when there are no pages #1491
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
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.
The
UndefRefErrorin #1201 happens when you do not have any pages (i.e. any.mdfiles undersrc/). ThenmenuatDocumenter.jl/src/Writers/HTMLWriter.jl
Lines 963 to 964 in bc1f73c
will be a
Node("")with uninitialized fields. It doesn't really make sense to build anything if there are no pages, so we'll try to bail early with a more helpful message in that situation.Having an
index.mdis not actually necessary for a build to complete, but the docs do end up slightly broken if you don't have it, so we'll also print a warning ifsrc/index.mdis missing.