-
Notifications
You must be signed in to change notification settings - Fork 15
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
makeshift doc-action fix #106
Conversation
@@ -10,8 +10,10 @@ makedocs(sitename="FMIFlux.jl", | |||
format = Documenter.HTML( | |||
collapselevel = 1, | |||
sidebar_sitename = false, | |||
edit_link = nothing | |||
edit_link = nothing, | |||
size_threshold_ignore = ["examples/juliacon_2023.md"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is it possible to ignore size for all examples in general? (because otherwise if we add more in the future, we need to track the examples in this makefile, which is error prone)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Disabling size check (like here) is not recommended, as "svg printing" issues in might get obvious this way. Future doc improvement should implement this by setting a size limit, that is valid for all correctly rendered examples. juliacon example is still broken due to gif issue (similar to svg issue)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
disabling the size check in general is not possible
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
adding a larger threshold instead?
@@ -1,3 +1,2 @@ | |||
params/ | |||
*.png | |||
*.gif |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is because some examples are generating GIFs, if they are executed locally, GIFs are saved to this path.
Please don't change this file at all. Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
and the examples render svgs. so why should we handle gifs differently than svgs? they should both be saved, right?
removed build and svg problem:
fixes for update to documenter v1
downgrade from juila 1.9 to 1.8 for svg problem