deploy_sphinx_docs.yml

name: Deploy Sphinx documentation to Pages

on:
  pull_request:
    types: [opened, synchronize]
    paths:
      - 'docs/sphinx_doc/**/*'
  push:
    branches:
      - main

jobs:
  pages:
    runs-on: ubuntu-20.04
    steps:
    - name: Checkout
      uses: actions/checkout@v4
    - name: Setup Python ${{ matrix.python-version }}
      uses: actions/setup-python@master
      with:
        python_version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -v -e .[dev]
    - id: build
      name: Build Documentation
      run: |
        cd docs/sphinx_doc
        bash build_doc.sh
    - name: Upload Documentation
      uses: actions/upload-artifact@v3
      with:
        name: SphinxDoc
        path: 'docs/sphinx_doc/build/html'
    - uses: peaceiris/actions-gh-pages@v3
      if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: 'docs/sphinx_doc/build/html'