deploy_documentation.yml

name: Build and deploy documentation

on:
  push:
    branches:
      - "main"

  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:

      - name: Checkout code
        uses: actions/checkout@v3

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python-version }}
          cache: pip

      - name: Install Poetry
        uses: snok/install-poetry@v1

      - name: Install requirements
        run: poetry install --with docs

      - name: Compile static HTML
        run: poetry run python -m sphinx.cmd.build -b html docs/source docs/_build

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

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: 'docs/_build'

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