Developer Documentation

The following documentation is meant to help developers setup a local environment for building the Jupyter Book.

Installing

1. Install system dependencies:
   • Python >= 3.8.0
   • Poetry
2. Clone this repository.
3. Change directory to the repository.
4. Create and activate a virtual environment:

   # for example
   python3 -m venv .venv
   source .venv/bin/activate
   

5. Install project dependencies from pyproject.toml file:

   poetry install
   

Developing

To build the Jupyter Book, run the following command.

jb build .