docs.yml

name: deploy-book

# Run this when the master or main branch changes
on:
  push:
    branches:
      - '**'
    paths:
    - docs/guide/**

# This job installs dependencies, builds the book, and pushes it to `gh-pages`
jobs:
  deploy-book:
    runs-on: ubuntu-latest
    permissions:
      pages: write
      id-token: write
    steps:
    - uses: actions/checkout@v4

    # Install dependencies
    - name: Set up Python 3.11
      uses: actions/setup-python@v5
      with:
        python-version: '3.11'
        cache: pip # Implicitly uses requirements.txt for cache key

    - name: Install dependencies
      run: pip install -r docs/guide/requirements.txt

    # Build the book
    - name: Build the book
      run: |
        jupyter-book build docs/guide

    # Upload the book's HTML as an artifact
    - name: Upload artifact
      uses: actions/upload-pages-artifact@v3
      with:
        path: "docs/guide/_build/html"

    # Deploy the book's HTML to GitHub Pages
    - name: Deploy to GitHub Pages
      id: deployment
      uses: actions/deploy-pages@v4