deploy-docs.yml

name: Build and Deploy Docs

on:
  push:
    branches:
      - main
      - dev
    tags:
      - '*'

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v2
        with:
          fetch-depth: 0  # Ensures all history is fetched for sphinx-multiversion to detect all tags and branches

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

      - name: Setup Graphviz
        uses: ts-graphviz/setup-graphviz@v2

      - name: Install Dependencies
        run: |
          pip install poetry
          poetry install

      - name: Build Docs with sphinx-multiversion
        run: |
          poetry run sphinx-multiversion docs docs/_build/html

      - name: Prepare Deployment
        run: |
          touch ./docs/_build/html/.nojekyll
          git config --local user.email "action@github.com"
          git config --local user.name "GitHub Action"

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