JuliaGaussianProcesses / AbstractGPs.jl

Abstract types and methods for Gaussian Processes.
https://juliagaussianprocesses.github.io/AbstractGPs.jl/dev
Other
210 stars 20 forks source link

CompatHelper: bump compat for Documenter to 1 for package docs, (keep existing compat) #377

Closed github-actions[bot] closed 7 months ago

github-actions[bot] commented 9 months ago

This pull request changes the compat entry for the Documenter package from 0.27 to 0.27, 1 for package docs. This keeps the compat entries for earlier versions.

Note: I have not tested your package with this new compat entry. It is your responsibility to make sure that your package tests pass before you merge this pull request.

codecov[bot] commented 9 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (e70aef3) 96.95% compared to head (91cc39b) 96.95%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #377 +/- ## ======================================= Coverage 96.95% 96.95% ======================================= Files 12 12 Lines 394 394 ======================================= Hits 382 382 Misses 12 12 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

simsurace commented 7 months ago

I'm not so familiar with Documenter.jl. @devmotion I think you have more experience. Is it fine to put sizethreshold=nothing to make the tests pass?

devmotion commented 7 months ago

I think ideally we should reduce the size of the webpages, e.g., by outputting png images instead of large svgs. For instance, apparently the size of the HTML file for the mauna loa example is more than 6 MB 😱

That being said, to move on with this PR I think the next-best option is to open an issue that lists these examples and allows us to fix these in follow-up PRs, and set size_threshold_ignore to these pages in this PR. This is preferred over increasing the threshold more generally (see eg https://documenter.juliadocs.org/stable/lib/internals/writers/#Documenter.HTMLWriter.HTML).

simsurace commented 7 months ago

Ok I'll do it this way then.