jw3126 / UnitfulRecipes.jl

Plots.jl recipes for Unitful.jl arrays
MIT License
37 stars 10 forks source link

Fix doc warnings during CI? #62

Closed briochemc closed 3 years ago

briochemc commented 3 years ago

This is a docs PR. It essentially does 2 things:

briochemc commented 3 years ago

It seems this PR solves whatever the current issue is with the CI build of the documentation (see, e.g., PR #61).

Once this is merged (after @jw3126 or @gustaphe approves), I'll rebase #61 so we can get the docs deployed on the PR branch.

gustaphe commented 3 years ago

I'm not sure I understand what it does, but if it builds I have no objections.

briochemc commented 3 years ago

I'm not sure I understand what it does, but if it builds I have no objections.

I’m not entirely sure (I merely copied the line from Documenter’s docs) but AFAIU, when deploying the docs, Plots (Or rather the GR backend) tries to show the output on some GKS “workstation type“, which this line apparently specifies as a special, no-output type.

briochemc commented 3 years ago

Less warnings sounds good :)

Well it's more than that actually... As you can see here, I retriggered a past Documentation job that worked last month, and this time it failed just like PR #61. So I think we need this fix now.

briochemc commented 3 years ago

And to reassure you and save you a few clicks, this is what the current Documenter docs shows:

Screen Shot 2021-07-20 at 12 12 07 am
jw3126 commented 3 years ago

Thanks a lot @briochemc

briochemc commented 3 years ago

I merged this and we can always revert it back if I did something wrong (it only impacts how the docs are built, not the package itself really)!