The main branch will automatically be built and deployed. GitHub Actions will report an error on the Build Jupyter Book job if the notebooks don't execute completely (which currently happens because the code does not work when no coefficients are supplied), but it will still push the site to GitHub Pages. This allows us to easily see how the notebook fails and accurately reflects whatever is on the main branch.
Some files are added that makes this possible:
Configuration files that tell jupyter-book how the website should be built (which notebooks to use):
_config.yml
_toc.yml
An extra conda environment that provides pytest, nbmake, and jupyter-book independently from the igrf environment:
.bookbuilder/...
The github action configuration
.github/workflows/publish.yml
This PR will wait on https://github.com/IAGA-VMOD/IGRF14eval/pull/3 then I will tweak the notebooks to fix how the output site is displayed (e.g. fixing the page titles, and collapsing code blocks)
This takes the notebooks, executes them, and creates the site at https://iaga-vmod.github.io/IGRF14eval.
The main branch will automatically be built and deployed. GitHub Actions will report an error on the
Build Jupyter Bookjob if the notebooks don't execute completely (which currently happens because the code does not work when no coefficients are supplied), but it will still push the site to GitHub Pages. This allows us to easily see how the notebook fails and accurately reflects whatever is on the main branch.Some files are added that makes this possible:
igrfenvironment:.bookbuilder/....github/workflows/publish.ymlThis PR will wait on https://github.com/IAGA-VMOD/IGRF14eval/pull/3 then I will tweak the notebooks to fix how the output site is displayed (e.g. fixing the page titles, and collapsing code blocks)