build_deploy_docs.yml

name: Build and deploy docs
on:
  push:
    paths:
      - .github/workflows/build_deploy_docs.yml
      - docs/source/**
      - src/**/*.py
  pull_request:
    paths:
      - .github/workflows/build_deploy_docs.yml
      - docs/source/**
      - src/**/*.py
  workflow_dispatch:

jobs:
  build-docs:
    runs-on: ubuntu-22.04
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: "3.10.12"
          cache: pip
      - name: Install connector dependencies
        run: pip install -r src/requirements.txt
      - name: Install doc. dependencies
        run: pip install -r docs/requirements.txt
      - name: Build sphinx HTML
        run: sphinx-build -W -b html docs/source docs/build
      - uses: actions/configure-pages@v5
      - uses: actions/upload-pages-artifact@v3
        with:
          path: docs/build
  deploy:
    needs: [build-docs]
    runs-on: ubuntu-22.04
    if: github.ref == 'refs/heads/master' || github.event_name == 'workflow_dispatch'
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v4