deploy-pages.yml

name: Deploy to GitHub Pages

on:
  push:
    branches: [master]

jobs:
  deploy-to-pages:
    runs-on: ubuntu-latest

    steps:
      - name: 🛎️ Checkout
        uses: actions/checkout@v2

      - name: 🐍 Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: 3
          cache: pip
          cache-dependency-path: requirements-render.txt

      - name: 👷‍ Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements-render.txt

      - name: 🔧 Render with Sphinx
        run: python render.py ci

        # remove the .doctrees folder when building for deployment as it takes two thirds of disk space
      - name: 🔥 Clean up files
        run: rm -r render/.doctrees/

      - name: 🚀 Deploy to GitHub pages
        uses: JamesIves/github-pages-deploy-action@4.1.1
        with:
          branch: gh-pages # The branch to deploy to.
          folder: render # Synchronise with build.py -> build_directory
          single-commit: true # Delete existing files