docs.yml

name: Build and deploy docs

on:
  push:
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

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

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

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

      - name: Pandoc install
        uses: pandoc/actions/setup@v1.0.0
        with:
          version: 2.19

      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v5
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install ".[docs]"
          pip install "autodoc_pydantic==1.9.1"
      - name: Set environment
        run: |
          REPO_OWNER="${GITHUB_REPOSITORY%%/*}"
          REPO_NAME="${GITHUB_REPOSITORY#*/}"
          echo "GITHUB_PAGES_URL=https://$REPO_OWNER.github.io/$REPO_NAME" >> $GITHUB_ENV
      - name: Build the docs
        working-directory: ./docs
        run: |
          echo $GITHUB_PAGES_URL
          make html
          touch build/html/.nojekyll
      - name: Upload build artifacts
        uses: actions/upload-pages-artifact@v3
        with:
          path: './docs/build/html'

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