build-book.yml

name: Build and Publish JupyterBook Docs

on:
  workflow_dispatch:
  push:
    branches:
      - main
    paths:
      - "docs/**"
  pull_request:
    branches:
      - main
    paths:
      - "docs/**"

jobs:
  docs-build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repo
        uses: actions/checkout@v3

      - name: Setup Python 3.9
        uses: actions/setup-python@v4
        with:
          python-version: "3.9"

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install -r docs/requirements.txt

      - name: Build JupyterBook
        working-directory: ./docs
        run: |
          jupyter-book build .

      - name: Check links with html proofer
        uses: chabad360/htmlproofer@master
        with:
          directory: "./docs/_build/html"
          arguments: --assume-extension --disable-external --only_4xx
        continue-on-error: true

      - name: Publish book
        if: (github.event_name == 'push' && github.ref == 'refs/heads/main') || github.event_name == 'workflow_dispatch'
        uses: peaceiris/actions-gh-pages@v3.8.0
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/_build/html