docs.yaml

name: Publish Docs to GitHub Pages
on:
  push:
    branches:
      - develop
    paths:
      - "docs/**"
env:
  PYTHON_VERSION: "3.10"
jobs:
  build-publish:
    name: Build and publish docs
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ env.PYTHON_VERSION }}
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -U .[docs]
      - name: Build docs
        run: |
          cd docs
          make html
      - name: Publish to GitHub Pages
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: docs/_build/html