SunnySuite / Sunny.jl

Spin dynamics and generalization to SU(N) coherent states
Other
86 stars 19 forks source link

Build IJulia notebook for each doc example #144

Closed kbarros closed 1 year ago

kbarros commented 1 year ago

Each example in the docs should contain a link to a corresponding IJulia notebook. The latter should be automatically built in our "build docs" Github action.

Relative to the markdown docs, IJulia notebooks should:

Also, as part of the refresh, we should deal with #hide pragmas so that notebooks are fully executable.

kbarros commented 1 year ago

I started working on it, but the feature might depend on issues in other packages, e.g.: https://github.com/MakieOrg/Makie.jl/issues/3184 https://github.com/fredrikekre/Literate.jl/issues/222

Lazersmoke commented 1 year ago

If Literate can target IJulia, then surely it handles the hide tags correctly?