documentation.yml

name: documentation

on:
  push:
  pull_request:
  workflow_dispatch:
    inputs:
      deploy:
        description: 'Deploy documentation'
        required: false
        type: boolean

permissions:
  contents: write

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
      - name: Install dependencies
        run: |
          pip install --disable-pip-version-check uv
          uv sync --frozen --group docs
      - name: Sphinx build
        run: |
          uv run --frozen --group docs sphinx-build docs _build
      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v4
        if: github.event_name == 'workflow_dispatch' && github.event.inputs.deploy == 'true'
        with:
          publish_branch: gh-pages
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: _build/
          force_orphan: true