-
Notifications
You must be signed in to change notification settings - Fork 6
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
Remove Manifest.toml and append package version at the end of the examples #97
Conversation
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Codecov Report
@@ Coverage Diff @@
## master #97 +/- ##
=======================================
Coverage 95.78% 95.78%
=======================================
Files 4 4
Lines 285 285
=======================================
Hits 273 273
Misses 12 12 Continue to review full report at Codecov.
|
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
How about getting docs/make.jl to copy the Manifest.toml (created by Pkg.instantiate) from :/examples//Manifest.toml to :/docs/src/ and then add a link from the example to the Manifest? then you can just download the exact Manifest used in rendering it. |
* make literate.jl copy Manifests into rendered docs * remove examples Manifest.toml * Update docs/literate.jl Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Théo Galy-Fajou <[email protected]>
I ended up deleting the Manifest preview since we can simply download it. |
# The following gives a preview of the manifest | ||
# embedded in a "spoiler", but this is unfortunately very buggy |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ah I was just thinking of changing it to that... what did you find buggy about it ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the notebook it was not rendering well at all
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But this could be something we reserve to the markdown output...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be nice if we could hide the whole runtime info within a <details></details>
block.
Left a few minor changes to the output.
Otherwise looks good to me!
Once it's merged, we should do the same for the other packages:) |
Or would this be an argument for moving all the notebooks into a single JuliaGaussianProcessesTutorials.jl repo (as in SciMLTutorials)? Downside of that would be that we wouldn't immediately have them as integration tests for proposed changes anymore... 🤔 |
Co-authored-by: st-- <[email protected]>
…ses/ApproximateGPs.jl into tgf/remove_manifests
As discussed in the last JuliaGP meeting. The general opinion is to not save the Manifest.toml as it is too big a burden for developers. Now the current status of the Pkg is printed (hopefully at the end)