docs_deploy.yml

name: docs

on:
    release:
        types: [published]
    workflow_dispatch:

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

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

jobs:
    build:
        runs-on: ubuntu-latest
        steps:
            - name: Checkout
              uses: actions/checkout@v4
              with:
                  fetch-depth: 0

            - name: Set up Python
              uses: actions/setup-python@v4
              with:
                  python-version: "3.10"

            - name: Install dependencies
              run: |
                  python -m pip install --upgrade pip
                  pip install sphinx sphinx_rtd_theme
                  pip install -e .
                  if [ -f docs/requirements.txt ]; then pip install -r docs/requirements.txt; fi

            - name: Build docs
              run: |
                  cd docs
                  make html
                  # Create .nojekyll file to prevent GitHub Pages from ignoring files that start with an underscore
                  touch _build/html/.nojekyll

            - name: Upload artifact
              uses: actions/upload-pages-artifact@v3
              with:
                  path: docs/_build/html

    deploy:
        environment:
            name: github-pages
            url: ${{ steps.deployment.outputs.page_url }}
        needs: build
        runs-on: ubuntu-latest
        steps:
            - name: Deploy to GitHub Pages
              id: deployment
              uses: actions/deploy-pages@v4