docs.yml

name: Deploy Documentation

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

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@v5
      with:
        fetch-depth: 0

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

    - name: Cache dependencies
      uses: actions/cache@v4
      with:
        path: ~/.cache/pip
        key: ${{ runner.os }}-pip-docs-v2-${{ hashFiles('docs/requirements.txt') }}-${{ hashFiles('pyproject.toml') }}
        restore-keys: |
          ${{ runner.os }}-pip-docs-v2-

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install --upgrade setuptools wheel
        # Install package first without documentation dependencies
        pip install -e . --no-deps
        # Install core dependencies
        pip install "pynwb>=2.8.2" "hdmf>=3.14.1" "hedtools>=0.7.1"
        # Install documentation dependencies (this will override any conflicting versions)
        pip install --force-reinstall -r docs/requirements.txt
        
    - name: Verify sphinx extensions
      run: |
        python -c "import sphinx_design; print(f'sphinx_design version: {sphinx_design.__version__}')"
        python -c "import sphinx_book_theme; print(f'sphinx_book_theme version: {sphinx_book_theme.__version__}')"
        python -c "import sphinx; print(f'sphinx version: {sphinx.__version__}')"
        
    - name: Install missing extensions (fallback)
      if: failure()
      run: |
        echo "Installing fallback dependencies..."
        pip install --force-reinstall "sphinx>=8.1.3" "sphinx-design>=0.6.1" "sphinx-book-theme>=1.1.3" "sphinx-copybutton>=0.5.2" "myst-parser>=4.0.0"

    - name: Build documentation
      run: |
        cd docs
        make html
      env:
        SPHINXOPTS: "--keep-going"

    - name: Setup Pages
      uses: actions/configure-pages@v5

    - name: Upload artifact
      uses: actions/upload-pages-artifact@v4
      with:
        path: ./docs/build/html

  #------------------------------------------------
  # Deploy Job: Deploys the built site
  #------------------------------------------------
  deploy:
    # This job depends on the 'build' job completing successfully
    needs: build
    # Only deploy when pushing to main branch, not on pull requests
    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
    permissions:
      pages: write
      id-token: write
    runs-on: ubuntu-latest

    # Specify the deployment environment
    environment:
      name: github-pages
      # The URL will be automatically set by the deployment step's output
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - name: Deploy to GitHub Pages
        # This is the official action for deploying the artifact to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4