cal-icor documentation

A short example showing how to write a lecture series using Jupyter Book 2.0.

Creating an Conda Environment

The conda environment is provided as environment.yml. This environment is used for all testing by Github Actions and can be setup by:

1. conda env create -f environment.yml
2. conda activate cal-icor-docs

Building a Jupyter Book

Run the following command in your terminal:

jb build .

If you would like to work with a clean build, you can empty the build folder by running:

jb clean .

If jupyter execution is cached, this command will not delete the cached folder.

To remove the build folder (including cached executables), you can run:

jb clean --all book/

Publishing this Jupyter Book

This repository is published automatically to gh-pages upon push to the main branch.

Notes

This repository is used as a test case for jupyter-book and a requirements.txt file is provided to support this CI application.