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

makeshift doc-action fix #106

Merged
merged 1 commit into from
Nov 3, 2023
Merged

makeshift doc-action fix #106

merged 1 commit into from
Nov 3, 2023

Conversation

0815Creeper
Copy link
Contributor

removed build and svg problem:
fixes for update to documenter v1
downgrade from juila 1.9 to 1.8 for svg problem

examples/src/.gitignore Outdated Show resolved Hide resolved
docs/Project.toml Outdated Show resolved Hide resolved
@@ -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"]
Copy link
Owner

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)

Copy link
Contributor Author

@0815Creeper 0815Creeper Oct 27, 2023

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)

Copy link
Contributor Author

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

Copy link
Owner

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

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!

Copy link
Contributor Author

@0815Creeper 0815Creeper Oct 30, 2023

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?

@ThummeTo ThummeTo merged commit bb2f11f into ThummeTo:main Nov 3, 2023
8 of 14 checks passed
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.

2 participants