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

Launching the example "2D dcaying turbulence" in binder does not work #203

Closed
ranocha opened this issue Mar 4, 2021 · 2 comments · Fixed by #207
Closed

Launching the example "2D dcaying turbulence" in binder does not work #203

ranocha opened this issue Mar 4, 2021 · 2 comments · Fixed by #207
Labels
🐞 bug Something isn't working 📔 documentation

Comments

@ranocha
Copy link
Contributor

ranocha commented Mar 4, 2021

I get
image

@navidcy
Copy link
Member

navidcy commented Mar 5, 2021

Pfff... this is unfortunately due to the large size the gh-pages branch has reached...

You see, the way the binder urls work in Documenter.jl via Literate.jl (as far as I understand at least -- I may be wrong) is that it makes a clone of the documentation gh-pages repository, from which they get the .toml files to build the environment. Due to 1) the large number of examples we have incorporated into the Docs which include animations and 2) the several GeophysicalFlows.jl releases we made, the gh-pages branch size has become >1GB and thus binder errors!

I don't really know how to alleviate this problem. I've tried many times to clean up the gh-pages branch, asked around in slack and googled a lot... Still haven't figure how to deal with this in a simple manner. It gives me bad dreams... :)

Perhaps @mortenpi or @fredrikekre have some idea on how to make this work? If not, I'm tempted to simply remove the binder urls from the examples in the Documentation.

@navidcy navidcy added 🐞 bug Something isn't working 📔 documentation labels Mar 5, 2021
@mortenpi
Copy link

mortenpi commented Mar 5, 2021

If the issue is the size of the gh-pages branch (which you can't really reduce, since you want the examples etc), I think the only way to make it work would be to store the notebooks in a separate repository. You'd need to customise docs/make.jl quite a bit to make that work though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐞 bug Something isn't working 📔 documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants