docs.yml

# This workflow builds and deploys the documentation when there is a push event to either the main or devel branch
name: Documentation

on:
  push:
    branches:
      - master
      - devel

jobs:
  docs:
    runs-on: ubuntu-latest
    permissions:
      contents: write

    steps:
      - name: Checkout Repository
        uses: actions/checkout@v4

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

      - name: Install Dependencies
        run: |
          python -m pip install --upgrade pip
          pip install sphinx_rtd_theme myst_parser
          pip install .
          cd docs
          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi

      - name: Build Sphinx Documentation
        run: |
          sphinx-build docs/source _build

      - name: Deploy Sphinx Documentation
        uses: peaceiris/actions-gh-pages@v3
        with:
          publish_branch: gh-pages
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: _build/
          force_orphan: true