search

EO-College / cubes-and-clouds

This is the official repository for the online course 'Cubes & Clouds'
https://eo-college.org/courses/cubes-and-clouds/
Creative Commons Attribution 4.0 International
32 stars 14 forks source link

Adding Github action & Jupyter-book to render nb #43

Closed annefou closed 4 days ago

annefou commented 3 months ago

The idea is to add a GitHub action to render the course (markdown and Jupyter notebooks) on Github webpages.

I made it in my fork: https://github.com/annefou/cubes-and-clouds/tree/main/.github/workflows

and the rendered Jupyter book is available online. For now in https://annefou.github.io/cubes-and-clouds

I suggest to add the same in the parent repo so anyone can read the course online, including Jupyter notebooks.

clausmichele commented 2 months ago

Hi @annefou, it looks great! Could you create a PR so that we can add it to the main repo?

annefou commented 1 month ago

It is done and I suggest we add some info and the link to the rendered Jupyter book version in CONTRIBUTING. The idea is to make it easier to check the rendered version from GitHub. Also we will add how to build the Jupyter book locally to help contributors to check their changes.

What do you think?

clausmichele commented 2 weeks ago

@annefou fine, can you or @tinaok add those additional info?