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

Documenter 1.0 #80

Closed
ArnoStrouwen opened this issue Sep 23, 2023 · 7 comments · Fixed by #81
Closed

Documenter 1.0 #80

ArnoStrouwen opened this issue Sep 23, 2023 · 7 comments · Fixed by #81

Comments

@ArnoStrouwen
Copy link

Could DocumenterTools be made compatible with Documenter 1.0?
At least one SciML documentation upgrade is blocked by this.

@mortenpi
Copy link
Member

Out of curiosity, which one? I'm wondering why/how you're actually using it during a documentation build.

@ArnoStrouwen
Copy link
Author

It is Optimization.jl.
I'm not familiar how/why it is used myself.

@mortenpi
Copy link
Member

I looked at SciML/Optimization.jl#594, but I didn't immediately see DocumenterTools anywhere?

Note: we need to update the compat here anyway, so this discussion is tangential to that.

@ArnoStrouwen
Copy link
Author

@mortenpi
Copy link
Member

It didn't really make sense to me that DocumenterTools would even be in that manifest, but here's where it's coming from:

(docs) pkg> why DocumenterTools
  OptimizationSpeedMapping → SpeedMapping → DocumenterTools

Will PR SpeedMapping to have it removed, since it's not actually using it.

@Datseris
Copy link

+1 to this. Note that in JuliaDynamics we genuinely use DocumenterTools. Specifically, and as I have pointed out on Slack, we do:

using Documenter
using DocumenterTools: Themes

which no longer works. We get the error: Themes not defined.

See here: https://github.com/JuliaDynamics/ComplexityMeasures.jl/actions/runs/6300078885/job/17102094879#step:5:10

That's the package versions we get installed:

https://github.com/JuliaDynamics/Attractors.jl/actions/runs/6281895507/job/17060755223?pr=94#step:4:27 ; Documetner Tools resolves to v0.1.2

However, Documenter resolves to version 1+: https://github.com/JuliaDynamics/Attractors.jl/actions/runs/6281895507/job/17060755223?pr=94#step:4:249

please, please do consider fixing DocumenterTools.jl. it would take so much effort for me to change 20 package's build, only to change it back again to documenter 1.0 later.


p.s.: I don't understand how NicolasL-S/SpeedMapping.jl#14 would fix things, as the dependency there is 0.1. It is not blocking, the latest stable of DocumenterTools.jl is indeed 0.1.

@mortenpi
Copy link
Member

p.s.: I don't understand how NicolasL-S/SpeedMapping.jl#14 would fix things, as the dependency there is 0.1. It is not blocking, the latest stable of DocumenterTools.jl is indeed 0.1.

Because that's the reason why it ends up in the Optimization.jl manifest. No DocumenterTools, no problem with Documenter 1.0. But, of course, it won't help you if you legitimately need to combine Documenter 1.0 with DocumenterTools.

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 a pull request may close this issue.

3 participants