Getting warning generated HTML from md file is too big

General Usage
1

I am getting the following warning about two of my md files in my docs.

julia> servedocs()
[ Info: SetupBuildDirectory: setting up build directory.
[ Info: Doctest: running doctests.
[ Info: ExpandTemplates: expanding markdown templates.
[ Info: CrossReferences: building cross-references.
[ Info: CheckDocument: running document checks.
[ Info: Populate: populating indices.
[ Info: RenderDocument: rendering document.
[ Info: HTMLWriter: rendering HTML pages.
┌ Warning: Generated HTML over size_threshold_warn limit: ChapterFFlexure.md
│     Generated file size: 188.83 (KiB)
│     size_threshold_warn: 100.0 (KiB)
│     size_threshold:      200.0 (KiB)
│     HTML file:           ChapterFFlexure/index.html
└ @ Documenter.HTMLWriter C:\Users\CMILLER\.julia\packages\Documenter\tbj1p\src\html\HTMLWriter.jl:1868
┌ Warning: Generated HTML over size_threshold_warn limit: Shapes.md
│     Generated file size: 120.92 (KiB)
│     size_threshold_warn: 100.0 (KiB)
│     size_threshold:      200.0 (KiB)
│     HTML file:           Shapes/index.html
└ @ Documenter.HTMLWriter C:\Users\CMILLER\.julia\packages\Documenter\tbj1p\src\html\HTMLWriter.jl:1868

The size seems too big for what the page is. See Chapter F - Flexure · AISCSteel.jl. Is this too big? If so, then I just have to split it up into more documents?

1 Like
2

You can opt-out of the size check. See:

The warning is a sanity check for people accidentally including massive outputs.

2 Likes
3

No, you don’t have to… you could just increase the limits for the warning. Your documentation seems fine to me. The warning is just to prevent situations where pages get too large accidentally, and is somewhat arbitrary. As long as you’re setting things up deliberately, it should be fine (up to a point)

3 Likes
5

I think the safeguard is great to not accidentally have an ascii output of some binary file. To add to the previous answers, a concrete example how to raise the limits is

That way you can have a bit longer pages or even some longer lists, raise the limit carefully but still have a safeguard to not accidentally bloat your docs.

2 Likes