docs.yml

name:  Deploy Documentation

# on:
#   push:
#     tags:
#       - '*'
on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  update_docs:
    name: Build and Deploy Documentation
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash -l {0}
    steps:
      - name: Cancel Previous Runs
        uses: styfle/cancel-workflow-action@0.11.0
        with:
          access_token: ${{ github.token }}

      - name: Checkout
        uses: actions/checkout@v3

      - name: Setup Python
        uses: actions/setup-python@v4
        with:
          python-version: 3.x

      - name: Create Cache ID
        run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV

      - name: Setup Cache
        uses: actions/cache@v3
        with:
          key: mkdocs-material-${{ env.cache_id }}
          path: .cache
          restore-keys: |
            mkdocs-material-

      - name: Install Dependencies
        run: |
          pip install mkdocs mkdocstrings mkdocstrings-python mkdocs-material
          git config user.name 'github-actions[bot]'
          git config user.email 'github-actions[bot]@users.noreply.github.com'

      - name: Deploy Docs
        run: |
          cd docs
          mkdocs gh-deploy --force