sphinx_docs_to_gh-pages.yml

name: Deploy Sphinx documentation to Pages

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  docs:
    runs-on: ubuntu-latest

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

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.12'

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r docs/requirements.txt
          pip install -e .

      - name: Build documentation
        run: sphinx-build -E -b html . _build/html
        working-directory: docs/source

      - name: Add .nojekyll file
        run: touch _build/html/.nojekyll
        working-directory: docs/source

      - name: Upload documentation artifact
        uses: actions/upload-artifact@v4
        with:
          name: sphinx-docs
          path: docs/source/_build/html

      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v4
        if: github.ref == 'refs/heads/main'
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: docs/source/_build/html
          publish_branch: gh-pages
          force_orphan: true