cookiecutter-science-project
cookiecutter-science-project copied to clipboard
Added jupyter-book feature, originally suggested in #28 by dcherian.
Configuration is set to only render notebooks and not rerun them (see _config.yml). Jupyter book is built in separate subdirectory (see notebooks/jupyter-book) to reduce clutter. Added dummy notebook in notebooks directory.
Note that there is an issue with first-time deployments on using GITHUB_TOKEN. See https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-first-deployment-with-github_token.
Check out this pull request on
See visual diffs & provide feedback on Jupyter Notebooks.
Powered by ReviewNB
Hey. Here's the next contribution. It's based on a suggestion from issue #28 by dcherian.
I've found it useful for viewing notebooks on GitHub. In the past I was telling people to use https://nbviewer.jupyter.org/ if they couldn't view a notebook on GitHub. With jupyter-book, I don't have to do this. I just tell people to click on the gihub-pages link and the notebooks can be viewed without a problem.*
They might also be useful for issue #21 . I've been able to get some students to use Binder ('click on the binder link in the Jupyter Book') without too much difficulty. I haven't got loads of feedback from this feature, so it could be useful to get feedback from others who have more experience.
*There is an issue with the first deployment when using GITHUB_TOKEN (see https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-first-deployment-with-github_token). As far as I know, this can be fixed by setting a personal access token instead. But it seems to me that setting a personal access token might require more explanation, and so using the solution at https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-first-deployment-with-github_token seems fine to me. Probably best to try all of this out yourself with a dummy project, and see how easy/complicated it is.
This is awesome. Thanks @nenb. I hope I find some time this week to look into this further.
Similarly to #47, how can we make sure that this feature is completely 'opt-in'? The simplest way I could think of, is to have the workflow yaml files in another folder, and then instruct the user to copy them to .workflows
. But perhaps someone has a sleeker idea?