gh-pages.yml

name: Build and Publish Docs

on:
  push:
    branches: [ main ]
  workflow_dispatch:

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

jobs:
  deploy:
    runs-on: ubuntu-latest
    environment:
      name: github-pages
    steps:
      - uses: actions/checkout@v3

      - uses: actions/setup-python@v4
        with:
          python-version: '3.10'

      - name: Install amago
        run: |
          pip install --upgrade pip
          pip install -e .

      - name: Install docs dependencies
        run: |
          python -m pip install --upgrade pip
          pip install \
            sphinx \
            sphinx-rtd-theme \
            gin-config \
            sphinx-autodoc-typehints \
            sphinx-book-theme

      - name: Build Sphinx HTML
        run: |
          cd docs
          make clean html


      - name: Configure Pages
        uses: actions/configure-pages@v4

      - name: Upload Pages Artifact  
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/build/html/

      - name: Deploy to GitHub Pages  
        uses: actions/deploy-pages@v4