name: API Docs

on:
  push:
    branches:
      - main
  pull_request:

# ─────────────────────────────────────────────────────────────────────────────
# Doc-build — informational only
#
# Generates Doxygen HTML from the public headers and reports warning
# statistics.  Does NOT block merges: `continue-on-error: true` ensures
# warnings or extraction issues never fail the CI gate.  When Doxygen
# coverage is denser (Phase 8c), this job can be promoted to a hard
# requirement and the HTML deployed to Pages.
#
# Note: Gitea Actions on GHES does not support `actions/upload-artifact@v4`,
# so HTML artifact upload is intentionally omitted.  The warning summary
# in the job log is the primary reviewer signal; reviewers who want the
# HTML can rebuild it locally with `cmake --build build --target doc`.
# ─────────────────────────────────────────────────────────────────────────────
jobs:
  doc-build:
    if: github.event_name == 'pull_request'
    runs-on: eulernest
    container:
      image: git.eulernest.eu/conformallab/ci-cpp:latest
    continue-on-error: true   # never block the merge
    steps:
      - uses: actions/checkout@v4

      - name: Generate API documentation
        run: doxygen Doxyfile 2>&1 | tee doxygen.log

      - name: Summarise warnings
        if: always()
        run: |
          if [ -f doc/doxygen/doxygen-warnings.log ]; then
            warn=$(wc -l < doc/doxygen/doxygen-warnings.log)
            echo "DOC ▸ Doxygen warnings: $warn"
            echo ""
            echo "First 20 warnings:"
            head -20 doc/doxygen/doxygen-warnings.log
          else
            echo "DOC ▸ No warning log produced — check that Doxyfile WARN_LOGFILE points to doc/doxygen/doxygen-warnings.log"
          fi

      - name: Report HTML output
        if: always()
        run: |
          if [ -d doc/doxygen/html ]; then
            files=$(find doc/doxygen/html -type f | wc -l)
            size=$(du -sh doc/doxygen/html | cut -f1)
            echo "DOC ▸ HTML output: $files files, $size total"
          fi