doc-deploy.yml

name: Publish Document Pages

on:
  push:
    branches:
      - main

jobs:
  doc-deploy:
    name: Deploy document pages
    runs-on: ubuntu-latest
    container: 'python:3.11-slim'
    steps:
      - name: Install host dependencies
        run: |
          apt-get -qq update
          apt-get install -qqy gcc git rsync

      - uses: actions/checkout@v2

      - name: Install Python dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install --upgrade poetry
          poetry install  --with=dev

      - name: Build the documents
        run: poetry run sphinx-build -b html docs-source docs

      - name: Deploy to GitHub Pages
        uses: JamesIves/github-pages-deploy-action@v4.4.1
        with:
          branch: gh-pages
          folder: docs