build-and-deploy-docs.yml

name: docs/gh-pages
on:
  release:
    types: [workflow_dispatch, released]

jobs:
    build-docs:
        name: Build docs and push to gh-pages
        runs-on: ubuntu-18.04
        steps:
            - name: Checkout branch
              uses: actions/checkout@v2

            - name: Setup python 
              uses: actions/setup-python@master
              with:
                python-version: 3.10.5
            
            - name: Install poetry
              uses: snok/install-poetry@v1.3.3
              with:
                version: 1.2.2
                virtualenvs-create: true
                virtualenvs-in-project: true
                installer-parallel: true

            - name: Load cached venv
              id: cached-poetry-dependencies
              uses: actions/cache@v2
              with:
                path: .venv
                key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
            
            - name: Install dependencies
              if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
              run: poetry install --no-interaction --no-root

            - name: build docs
              run: |
                source .venv/bin/activate
                cd docs
                make clean
                make html
                cd ..
            
            - name: Deploy to GitHub Pages
              uses: Cecilapp/GitHub-Pages-deploy@v3
              env:
                GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
              with:
                email: dhagan@mit.edu
                build_dir: docs/_build/html