Dagger.jl icon indicating copy to clipboard operation
Dagger.jl copied to clipboard

Updating to Documenter.jl v1

Open JamesWrigley opened this issue 1 year ago • 3 comments

I attempted to update the docs to build with Documenter.jl v1, but it seems that there are dependency conflicts. I narrowed it down to:

  • The docs project depending on DaggerWebDash
    • Which depends on ProfileSVG.jl
      • Which has a compat bound to FlameGraphs.jl v0.2 (an old version)
        • Which has a compat bound to an old version of AbstractTrees.jl
          • Which is incompatible with Documenter.jl v1: https://github.com/JuliaDocs/Documenter.jl/blob/master/Project.toml#L32

This PR would fix it: https://github.com/kimikage/ProfileSVG.jl/pull/70 But I'm not sure if that'll get merged anytime soon. Anyway it's not urgent, I just wanted to document the chain of pain :grin:

JamesWrigley avatar Mar 11 '24 11:03 JamesWrigley

Thanks for looking into this! I'd be ok with removing ProfileSVG support from DaggerWebDash for now - it's not really used, since profiling support in Dagger isn't great, because Profile doesn't support continuous profiling (yet another chain of pain :laughing: ).

jpsamaroo avatar Mar 11 '24 17:03 jpsamaroo

If it's a web viewer, you could try switching to ProfileCanvas.jl instead? Not sure if it needs a live server, though.

Alternatively, you can always just add that branch in CI explicitly!

asinghvi17 avatar Mar 18 '24 13:03 asinghvi17

The live rendering support is enabled by running ProfileSVG multiple times, so ProfileCanvas.jl could work! Thanks for letting me know about it :smile:

jpsamaroo avatar Mar 20 '24 21:03 jpsamaroo

Fixed in #487.

JamesWrigley avatar Mar 21 '24 19:03 JamesWrigley