documentation.yml

---
name: documentation

on: [push, pull_request]

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  build:
    # Ubuntu 20.04 has Python 3.9
    runs-on: ubuntu-20.04

    steps:
      - uses: actions/checkout@v2
      - name: Set up Python 3.9
        uses: actions/setup-python@v2
        with:
          python-version: "3.9"
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install -r requirements_github.txt
          python -m pip install sphinx sphinx-autodoc-typehints
      - name: Run Sphinx build
        run: make doc
      - name: Upload doc artifacts
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./doc/build/html

  deploy:
    # Only deploy on 'master' branch. It's probably still useful to check
    # if the docs actually build on other branches, too.
    if: github.ref == 'refs/heads/actions_test'
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4