docs.yaml

name: docs

on:
  push:
    branches: ["main"]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        
      - name: Install Pandoc
        run: sudo apt-get install -y pandoc

      - name: Install Python build dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r ${{ github.workspace }}/docs/requirements.txt
          python3 -m pip install .[opensimplex]

      - name: Build Sphinx documentation
        working-directory: ${{ github.workspace }}/docs
        run: |
          make clean
          make html

      - name: Package artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ${{ github.workspace }}/docs/_build/html

  deploy:
    needs: build
    permissions:
      pages: write
      id-token: write

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4