build_doc.yml

name: Documentation

on:
  push:
    branches:
      - 'main'
  pull_request:

jobs:
  doc_ubuntu:
    name: ⚙️ Build documentation on Ubuntu
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v1

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

      - name: Install Python dependencies
        run: |
          python -m pip install --upgrade pip
          pip3 install -r docs/requirements.txt

      - name: Build doc
        run: sphinx-build -a docs ./build-docs

  broken_links_check:
    name: 🔗 Look for broken links
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v1

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '24'

      - name: Install markdown-link-check
        run: npm install -g markdown-link-check@3.13.7

      - name: Check all Markdown links
        run: |
          BROKEN_LINKS=$(markdown-link-check -q ./docs)
          if [ -n "$BROKEN_LINKS" ]; then
            echo "❌ Found broken links: $BROKEN_LINKS"
            exit 1
          else
            echo "✔️ No broken links found"
            exit 0
          fi