documentation.yaml

name: Documentation

on:
  push:
    branches: [main]

jobs:
  Documentation:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository
        uses: actions/checkout@master
      - name: Set up python
        uses: actions/setup-python@v4
        with:
          python-version: '3.7'
      - name: Load cached Poetry installation
        uses: actions/cache@v3
        with:
          path: ~/.local  # the path depends on the OS
          key: poetry-0  # increment to reset cache
      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          version: 1.3.2
          virtualenvs-in-project: true
      - name: Install dependencies
        run: poetry install --only docs
      - name: Set up Git
        run: |
          git config user.name ${{ github.actor }}
          git config user.email ${{ github.actor }}@users.noreply.github.com
      - name: Build documentation
        run: |
          git fetch origin gh-pages
          poetry run mike delete main
          poetry run mike deploy --push main