Building the book

Building the book

Dependencies

Install the Python dependencies in a virtual environment:

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Local server

To run the book using a local server with live reload:

cd book
jupyter book start

HTML build

To build the HTML version of the book:

cd book
myst build --html

For a full local build with executed notebooks (as in CI), use:

cd book
myst build --html --execute

Or from the repository root, which also runs the checkers and copies the apps into the built site:

./scripts/verify-book-build.sh

The built site appears in book/_build/html/; the apps are copied to book/_build/html/apps/.

Run the full build before every push (optional)

CI already runs myst build --html --execute on main. To run the same check locally before git push, enable this repository's hooks once:

git config core.hooksPath .githooks

To push without the check (for example a work-in-progress branch):

SKIP_BOOK_VERIFY=1 git push

Deployment

Every push to main triggers .github/workflows/deploy.yml, which runs the checkers, builds the book with executed notebooks, copies the apps, and publishes the result to GitHub Pages at https://fourms.github.io/Creative-AI/.