publish_docs.yml

name: Publish docs

on:
  push:
    branches:
      - main
permissions:
  contents: write

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: actions/setup-python@v4
        with:
          python-version: 3.x

      - name: Install dependencies
        run: |
          pip install -r docs/requirements-docs.txt

      - name: Build docs
        run: |
          cd docs
          sphinx-build -b html . build/sphinx/html -W
          touch build/sphinx/html/.nojekyll  # allow underscores in URL path

      - name: Deploy to gh-pages 🚀
        uses: JamesIves/github-pages-deploy-action@4.1.4
        with:
          branch: gh-pages
          folder: docs/build/sphinx/html