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

Set up binder for deployed/generated notebook outputs #46

Closed
diegozea opened this issue Dec 6, 2018 · 4 comments
Closed

Set up binder for deployed/generated notebook outputs #46

diegozea opened this issue Dec 6, 2018 · 4 comments

Comments

@diegozea
Copy link

diegozea commented Dec 6, 2018

It will be great to have add a way to include a REQUIRE file in the gh-pages branch to use binder to interact with the generated outputs: https://github.com/binder-examples/demo-julia
Also, to have something similar to @__NBVIEWER_ROOT_URL__ to add the launch binder icon.

@fredrikekre
Copy link
Owner

Can you elaborate a bit more on what is needed? I have never worked with binder.

@diegozea
Copy link
Author

I don't have to much experience either. I think that binder needs for Julia a REQUIRE file in the repo directory that it's used to set up a docker image to run the IJulia notebook.
In this case, we need a way to add a REQUIRE file in the gh-pages branch during the deployment process. The REQUIRE file should have the list of Julia packages and the Julia version required to run the Literate-generated notebooks.
Then, as nbviewer, binder generates a link to the notebook, e.g.:
https://mybinder.org/v2/gh/binder-examples/demo-julia/master?filepath=demo.ipynb

@briochemc
Copy link
Contributor

briochemc commented Dec 3, 2019

I'm not sure why but the binder links for a package of mine do not work properly (e.g., here). Clicking on the link actually opens the notebook in binder but it cannot find the Julia kernel, as illustrated in this screenshot:

Screen Shot 2019-12-04 at 8 58 51 AM

Maybe I'm completely wrong about this but I think that binder works here (in the Literate binder example) because you manually added the docs/Project.toml and docs/Manifest.toml files from the master branch to the gh-pages branch in commit b5a0fc2.

If I am correct, these .toml files play the role of the REQUIRE mentioned in this issue, so it would be nice to automatically (or at least optionally) copy them from, e.g., the master branch to the gh-pages branch. (Also maybe just the Project.toml file is required?)

@fredrikekre
Copy link
Owner

Yea, you need to add them there.

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

3 participants