Skip to content
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

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

Merged

Conversation

github-actions[bot]
Copy link
Contributor

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.

@theogf theogf force-pushed the compathelper/new_version/2023-09-16-01-05-01-759-00417049995 branch from 62a3bb5 to 2c2bcd8 Compare September 16, 2023 01:05
@codecov
Copy link

codecov bot commented Sep 16, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

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

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs/Project.toml Outdated Show resolved Hide resolved
@simsurace
Copy link
Member

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
Copy link
Member

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
Copy link
Member

Ok I'll do it this way then.

docs/make.jl Outdated Show resolved Hide resolved
docs/make.jl Outdated Show resolved Hide resolved
docs/make.jl Outdated Show resolved Hide resolved
Copy link
Member

@willtebbutt willtebbutt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @devmotion . Please feel free to merge when formatting is sorted -- no need for a patch bump since files in src aren't changed.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@simsurace simsurace merged commit 9423e43 into master Nov 20, 2023
12 checks passed
@simsurace simsurace deleted the compathelper/new_version/2023-09-16-01-05-01-759-00417049995 branch November 20, 2023 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants