deploy-site.yml

name: Deploy the docs site
on:
  push:
    branches:
      - master
  workflow_dispatch:
permissions:
  contents: read
  id-token: write
  pages: write
concurrency:
  group: pages
  cancel-in-progress: true
jobs:
  build:
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - uses: actions/checkout@v4

      - name: Install dependencies
        run: |
            sudo apt-get install python3-pip python3-setuptools python3-wheel --assume-yes --install-recommends
            sudo pip3 install -r requirements.txt .

      - name: Build the docs site
        run: |
          mkdocs build

      - name: Upload docs site artifact
        uses: actions/upload-pages-artifact@v2
        with:
          path: ./site

      - name: Setup GitHub Pages
        uses: actions/configure-pages@v3

      - name: Deploy docs site to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2