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

Errors when generating documentation Pluto examples using Julia 1.11 #550

Open
Stockless opened this issue Mar 24, 2025 · 5 comments
Open
Assignees
Labels
documentation Improvements to docs., it also triggers doc preview

Comments

@Stockless
Copy link
Collaborator

The Pluto examples in examples/4.reproducible_notebooks/ that are built at docs/src/tutorial-pluto/ are presenting errors in the execution of its blocks.

@Stockless Stockless self-assigned this Mar 24, 2025
@cncastillo
Copy link
Member

This is probably because the notebooks were generates using Julia 1.10 and the docs recently changed to be run using Julia 1.11.

One potential solution is to change the version of Julia used to generate the docs to Julia 1.10.

@cncastillo cncastillo changed the title Error in Pluto examples generation Errors when generating Pluto examples Mar 24, 2025
@cncastillo cncastillo changed the title Errors when generating Pluto examples Errors when generating documentation Pluto examples using Julia 1.11 Mar 24, 2025
@cncastillo cncastillo added the documentation Improvements to docs., it also triggers doc preview label Mar 24, 2025
@Stockless
Copy link
Collaborator Author

The issue comes from #499 , apparently creating a phantom object in Pluto still expects the notation previous to this PR:

obj = Phantom{Float64}(x=[])

instead of

obj = Phantom()

This bug is only inside the Pluto notebooks, not outside of it.

@cncastillo
Copy link
Member

cncastillo commented Mar 25, 2025

This change is incorporated in Koma v0.9.1, the bug was introduced in 0.8.X, but the notebook should have the correct versions of the package. Like said previously, the problem is because the docs are using a different Julia version (v1.11) and re-resolving the dependencies. Either:

  • You run the documentation with Julia v1.10
  • Upgrade the packages to KomaMRI v0.9.1

There is not need to change the code, as the code run with the package versions specified in the its Manifest.

@Stockless
Copy link
Collaborator Author

The bug with the Phantom was found using Julia v1.10 and with the packages upgraded to KomaMRI v0.9.1.
Maybe @pvillacorta could know why is Pluto using the notation that was previous to the PR #499

@pvillacorta
Copy link
Collaborator

Hello, I could try to spend more time trying to solve this, but for now, I can't find an explanation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to docs., it also triggers doc preview
Projects
None yet
Development

No branches or pull requests

3 participants