docs-deploy.yml

name: "Deploy Docs"
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  # https://github.com/marketplace/actions/deploy-to-github-pages
  build-docs-deploy:
    runs-on: ubuntu-20.04
    steps:
    - name: Checkout 🛎️
      uses: actions/checkout@v4
      # If you're using actions/checkout@v4 you must set persist-credentials to false in most cases for the deployment to work correctly.
      with:
        persist-credentials: false
    - uses: actions/setup-python@v5
      with:
        python-version: 3.8

    # Note: This uses an internal pip API and may not always work
    # https://github.com/actions/cache/blob/master/examples.md#multiple-oss-in-a-workflow
    - name: Cache pip
      uses: actions/cache@v4
      with:
        path: ~/.cache/pip
        key: pip-${{ hashFiles('requirements.txt') }}
        restore-keys: pip-

    - name: Install dependencies
      run: |
        pip --version
        pip install -U -q -r requirements.txt -r docs/requirements.txt \
          -f https://download.pytorch.org/whl/cpu/torch_stable.html
        pip list

    - name: Make Documentation
      working-directory: ./docs
      run: make html --jobs 2

    - name: Deploy 🚀
      uses: JamesIves/github-pages-deploy-action@v4.6.8
      if: ${{ github.event_name == 'push' }}
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
        branch: gh-pages # The branch the action should deploy to.
        folder: docs/build/html # The folder the action should deploy.
        clean: true # Automatically remove deleted files from the deploy branch
        target-folder: docs # If you'd like to push the contents of the deployment folder into a specific directory
        single-commit: true # you'd prefer to have a single commit on the deployment branch instead of full history