docs.yml

name: Documentation
permissions: read-all  # Declare default permissions as read only.
on:
  push:
    branches: ["main"]
    paths: ["lib/**", "docs/**", "examples/**"]
  workflow_dispatch: {}
jobs:
  build:
    runs-on: ["ubuntu-latest"]
    permissions:
      contents: write
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.14"]
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip setuptools wheel
          pip install -e . -r docs/requirements.txt
      - name: Generate docs
        run: python bin/build_docs.py -cu
      - name: GitHub Pages action
        uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/