deploy_docs.yml

name: Deploy Sphinx Docs to GitHub Pages

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
    - name: Checkout repository
      uses: actions/checkout@v3

    - name: Set up Python
      uses: actions/setup-python@v4
      with:
        python-version: '3.11'

    - name: Cache pip dependencies
      uses: actions/cache@v3
      with:
        path: ~/.cache/pip
        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
        restore-keys: |
          ${{ runner.os }}-pip-
  
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install sphinx myst-parser pydata-sphinx-theme
        pip install -e .[dev]

    - name: Debug information
      run: |
        echo "Listing current directory:"
        ls -la
        echo "Listing unravel/docs directory:"
        ls -la unravel/docs
        echo "Current repository and branch:"
        git remote -v
        git branch

    - name: Build documentation
      run: |
        cd unravel/docs
        make html

    - name: Deploy to GitHub Pages
      uses: peaceiris/actions-gh-pages@v3
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_branch: gh-pages
        publish_dir: unravel/docs/_build/html