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

Build IJulia notebook for each doc example #144

Closed
kbarros opened this issue Aug 26, 2023 · 2 comments
Closed

Build IJulia notebook for each doc example #144

kbarros opened this issue Aug 26, 2023 · 2 comments
Assignees

Comments

@kbarros
Copy link
Member

kbarros commented Aug 26, 2023

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:

  • Use WGLMakie if in IJulia environment
  • Have appropriate default resolution
  • Have the correct shade of gray for spins (perhaps this WGLMakie bug could be fixed?)
  • Have appropriate size of axis labels (this might get easier with Makie 0.20)
  • Generate the correct HTML for image links

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

@kbarros
Copy link
Member Author

kbarros commented Aug 27, 2023

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

@Lazersmoke
Copy link
Contributor

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

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

No branches or pull requests

2 participants