docs.yml

name: Docs

on:
  # Runs on pushes targeting the main branch
  push:
    branches: 
      - "main"
    paths:
      - "docs/**/*"

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

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  # Single deploy job since we're just deploying
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.11'

      - name: Install Python Dependencies
        shell: bash
        run: |
          python3 -m venv .linux-venv
          source .linux-venv/bin/activate
          pip install --upgrade -r requirements.txt

      - name: Build Mkdocs
        shell: bash
        run: |
          export GA_ID=${{ secrets.GA_ID }}
          source .linux-venv/bin/activate
          mkdocs build

      - name: Setup Pages
        uses: actions/configure-pages@v4

      - name: Upload Built Docs
        uses: actions/upload-pages-artifact@v3
        with:
          path: './site'

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4