docs-deploy.yml

name: Build Documentation

on:
  push:
    branches: ["master"]
  workflow_dispatch:

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: Setup Pages
        uses: actions/configure-pages@v5
      
      - name: Checkout Repository
        uses: actions/checkout@v4

      # Need to install prereqs for Weasyprint
      - name: Install Prerequisites
        run: sudo DEBIAN_FRONTEND=noninteractive apt-get install -y libpango-1.0-0 libharfbuzz0b libpangoft2-1.0-0

      - name: Setup Python and Dependencies
        uses: actions/setup-python@v5
        with:
          python-version: 3.x
          cache: 'pip' # caching pip dependencies
      - run: pip install -r requirements.txt

      - name: Build site
        run: mkdocs build -d _docs/

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          # Upload directory generated above
          path: '_docs'

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