docs-deploy.yml

name: Deploy Sphinx docs to GitHub Pages

on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "op3/**/*.py"
      - ".github/workflows/docs-deploy.yml"
      - ".readthedocs.yaml"
  workflow_dispatch:

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

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"

      - name: Install pandoc (for nbsphinx)
        run: sudo apt-get update && sudo apt-get install -y pandoc

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r docs/sphinx/requirements.txt
          # Do NOT pip-install op3 itself -- openseespy has no manylinux
          # wheel. autodoc_mock_imports in conf.py handles it.

      - name: Build HTML
        run: |
          sphinx-build -b html docs/sphinx docs/sphinx/_build/html \
            -d docs/sphinx/_build/doctrees \
            -W --keep-going || true
          # Add .nojekyll so GitHub Pages does not mangle underscore-prefixed files
          touch docs/sphinx/_build/html/.nojekyll

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

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