publish-docs.yml

name: Publish Documentation
on:
  push:
    branches:
        - main
    tags:
        - "^[0-9]+.[0-9]+.[0-9]+"

jobs:
    build_pages:
        runs-on: ubuntu-22.04
        steps:
            - uses: actions/checkout@v4
            - uses: actions/setup-python@v5
              with:
                python-version: 3.11
            - name: Install Poetry
              uses: abatilo/actions-poetry@v2
              with:
                poetry-version: 1.7.1
            - uses: actions/cache@v4
              name: Define a cache for the virtual environment based on the dependencies lock file
              with:
                path: ./.venv
                key: venv-${{ hashFiles('poetry.lock') }}
            - name: Install the project dependencies
              run: poetry install --with docs
            - name: Build documentation
              run: cd docs && poetry run make html
            - name: Upload html
              uses: actions/upload-pages-artifact@v1
              with:
                path: ./docs/_build/html
    deploy_pages:
        runs-on: ubuntu-latest
        needs: build_pages
        permissions:
          pages: write      # to deploy to Pages
          id-token: write   # to verify the deployment originates from an appropriate source
        # Deploy to the github-pages environment
        environment:
          name: github-pages
          url: ${{ steps.deployment.outputs.page_url }}
        steps:
          - name: Deploy to GitHub Pages
            id: deployment
            uses: actions/deploy-pages@v2 
            with:
              token: ${{secrets.GITHUB_TOKEN}}