generate-docs.yml

name: Deploy Documentation

on:
  workflow_dispatch:
  push:
    branches:
      - release

jobs:
  deploy-docs:

    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash -l {0}

    steps:
      - name: Checkout code
        uses: actions/checkout@v6

      - name: Install uv
        uses: astral-sh/setup-uv@v7
        with:
          enable-cache: true
          cache-dependency-glob: "**/pyproject.toml"
          python-version: '3.12'

      - name: Install dependencies
        run: |
          uv sync --group docs --group interactive --extra extras

      - name: Build the documentation
        run: |
          cd docs
          uv run make html

      - name: Publish the documentation to GitHub Pages
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/_build/html
          cname: openpnm.org