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

Remove Manifest.toml and append package version at the end of the examples #97

Merged
merged 18 commits into from
Jan 28, 2022

Conversation

theogf
Copy link
Member

@theogf theogf commented Jan 20, 2022

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)

docs/literate.jl Outdated Show resolved Hide resolved
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@codecov
Copy link

codecov bot commented Jan 20, 2022

Codecov Report

Merging #97 (817cce0) into master (9f258f8) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9f258f8...817cce0. Read the comment docs.

docs/literate.jl Outdated Show resolved Hide resolved
docs/literate.jl Outdated Show resolved Hide resolved
docs/literate.jl Outdated Show resolved Hide resolved
docs/literate.jl Outdated Show resolved Hide resolved
theogf and others added 2 commits January 20, 2022 18:13
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>
docs/literate.jl Outdated Show resolved Hide resolved
docs/literate.jl Outdated Show resolved Hide resolved
docs/literate.jl Outdated Show resolved Hide resolved
@st--
Copy link
Member

st-- commented Jan 21, 2022

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.

theogf and others added 4 commits January 27, 2022 16:52
* 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]>
docs/literate.jl Outdated Show resolved Hide resolved
@theogf
Copy link
Member Author

theogf commented Jan 27, 2022

I ended up deleting the Manifest preview since we can simply download it.

docs/literate.jl Outdated Show resolved Hide resolved
Comment on lines +73 to +74
# The following gives a preview of the manifest
# embedded in a "spoiler", but this is unfortunately very buggy
Copy link
Member

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 ?

Copy link
Member Author

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

Copy link
Member Author

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...

docs/literate.jl Outdated Show resolved Hide resolved
docs/literate.jl Outdated Show resolved Hide resolved
Copy link
Member

@st-- st-- left a 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!

@st--
Copy link
Member

st-- commented Jan 28, 2022

Once it's merged, we should do the same for the other packages:)
It would be nice if we didn't have to copy&paste the build scripts around. Could we make an JuliaGaussianProcessesDocUtils.jl package in which we bundle all these setups and export them as functions so that docs/make.jl could be a single function call (apart from using OurDocUtils, ApproximateGPs)?

@st--
Copy link
Member

st-- commented Jan 28, 2022

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... 🤔

.gitignore Show resolved Hide resolved
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

Successfully merging this pull request may close these issues.

3 participants