docs.yml

name: Deploy Docs

on:
  push:
    branches:
      - main
    paths:
      - 'documents/**'
      - 'mkdocs.yml'

permissions:
  contents: write

jobs:
  docs:
    name: mkdocs deploy
    runs-on: ubuntu-latest
    strategy:
      max-parallel: 4
      matrix:
        python-version: ["3.11"]

    steps:
    - name: Checkout code
      uses: actions/checkout@v3

    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v4
      with:
        python-version: ${{ matrix.python-version }}
    
    - name: Cache pip dependencies
      uses: actions/cache@v3
      with:
        path: ~/.cache/pip
        key: pip-cache-${{ matrix.python-version }}-${{ github.sha }}
        restore-keys: |
          pip-cache-${{ matrix.python-version }}-
          pip-cache-

    - name: Install MkDocs and dependencies
      run: pip install mkdocs-material

    - name: Check MkDocs Version
      run: mkdocs --version

    - name: Deploy Docs
      run: mkdocs gh-deploy --force