.github/workflows/documentation-release.yml

name: Docs

on:
  push:
    branches: [ stable ]
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
      - '.github/workflows/documentation.yml'

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

permissions:
  contents: write

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

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

      - name: Set up workflow cache
        uses: actions/cache@v3
        with:
          key: ${{ github.ref }}
          path: .cache

      - run: pip install mkdocs-material

      - run: mkdocs gh-deploy --force