documentation.yaml

---
name: Documentation

# Run workflow on pushes to matching branches
on:  # yamllint disable-line rule:truthy
  push:
    branches: [develop, latest]
  pull_request:
    branches: [develop, latest]

jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: ./docs/
    steps:
      - name: Checkout code
        uses: actions/checkout@v3
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: 3.11
      - name: Install dependencies
        run: |
          pip install -r requirements.txt
      - name: Sphinx build
        run: |
          make html SPHINXOPTS="-W"

  check_links:
    name: Check links
    runs-on: ubuntu-latest
    needs: build
    defaults:
      run:
        working-directory: ./docs/
    steps:
      - name: Checkout code
        uses: actions/checkout@v3
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: 3.11
      - name: Install dependencies
        run: |
          pip install -r requirements.txt
      - name: Sphinx build
        # Set warnings to be treated as errors
        run: |
          make html SPHINXOPTS="-W"
      - name: Link Checker
        uses: lycheeverse/lychee-action@v1.7.0
        with:
          args: --config='./.lychee.toml' --no-progress './docs/build/html/**/*.html'
          fail: true  # fail on broken links