deploy-github-pages.yaml

name: Deploy GitHub Pages
on:
  push:
    branches: [main]

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
    steps:
    - name: Git checkout
      uses: actions/checkout@v3

    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.11'
        cache: pip

    - name: create venv and install dependencies
      run: |
        rm -r /tmp/kazu-env || true

        PIP_CACHE_DIR=$(pip cache dir)
        echo "pip cache dir is "${PIP_CACHE_DIR}
        python -m venv /tmp/kazu-env
        . /tmp/kazu-env/bin/activate
        python -m pip install --upgrade pip
        pip install --upgrade --upgrade-strategy eager --index-url https://download.pytorch.org/whl/cpu "torch>=2.0.0"
        pip install -e ."[dev]" --cache-dir $PIP_CACHE_DIR --upgrade --upgrade-strategy eager

    - name: make sphinx docs
      # note: we don't make the 'doctest' target, because
      # we don't have the model pack here. This will have
      # been done already in the integration tests.
      run: |
        . /tmp/kazu-env/bin/activate
        make -C docs html
    - name: upload pages artifact
      uses: actions/upload-pages-artifact@v1
      with:
        path: ./docs/_build/html

  # Deploy job
  deploy:
    # Add a dependency to the build job
    needs: build

    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write      # to deploy to Pages
      id-token: write   # to verify the deployment originates from an appropriate source

    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    # Specify runner + deployment step
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2