github-pages.yml

name: GitHub Pages

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
  workflow_dispatch:

jobs:
  website-build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

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

      - name: Install package
        run: |
          pip install --upgrade pip
          pip install -e .[dev]

      - name: Build
        run: |
          sudo apt install pandoc
          sudo apt install graphviz
          make html
        working-directory: docs

      # github pages creates jekyll build by default, just want to point to index.html
      - name: Disable jekyll builds
        run: touch docs/_build/html/.nojekyll

      - name: Deploy
        #if: github.event_name == 'push'
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/_build/html