docs.yml

name: Build and Deploy Sphinx Docs

on:
  push:
    branches: [ main ]

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

jobs:
  docs:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repo
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"

      - name: Install project and doc tools
        run: |
          python -m pip install --upgrade pip
          pip install .
          pip install sphinx sphinx-rtd-theme

      - name: Build Sphinx HTML
        run: |
          sphinx-build -b html docs/source docs/_build/html
      - name: Add .nojekyll
        run: touch docs/_build/html/.nojekyll

      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v4
        with: 
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: docs/_build/html
          publish_branch: gh-pages
          force_orphan: true