deploy-docs.yml

name: deploy-docs

# Only run this when the master branch changes
on:
  push:
    branches:
    - main
    - master

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

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

    # Install dependencies
    - name: Set up Python 3.10
      uses: actions/setup-python@v3
      with:
        python-version: "3.10"

    - name: Install dependencies
      run: |
        pip install -e .[doc]

    # Build the book
    - name: Build the book
      run: |
        cd docs
        ./build_docs.sh

    - name: Upload artifact
      uses: actions/upload-pages-artifact@v1
      with:
        path: 'docs/_build/html'

    - name: Deploy to GitHub Pages
      id: deployment
      uses: actions/deploy-pages@v1