f6722d7e84
Replaces the hand-maintained `doc/api/headers.md` with a generated one
sourced from each header's `\file` brief and the public symbols
extracted by Doxygen into XML. The CI workflow regenerates it on every
push to main that touches the public headers.
New files
─────────
* scripts/gen-headers-md.py — parses doc/doxygen/xml/*.xml, groups
headers by directory (CGAL public / CGAL internals / Core), and
writes a markdown table with header path, first-sentence brief, and
the public symbols declared at file scope. Skips `detail::`
namespaces and template-specialisation duplicates.
* scripts/regen-docs.sh — convenience wrapper:
doxygen → gen-headers-md.py → coverage report.
Workflow changes
────────────────
.gitea/workflows/doxygen-pages.yml now:
1. Runs `bash scripts/doxygen-coverage.sh` as an informational step
(no fail threshold yet — the script supports `--threshold N` for
when we're ready).
2. Re-runs `python3 scripts/gen-headers-md.py` and warns if the
file drifted from what's in main (operator should run
`regen-docs.sh` locally before pushing).
Doxyfile hygiene
────────────────
`HTML_TIMESTAMP` was removed in Doxygen 1.10 → replaced with the new
`TIMESTAMP = NO` to silence the obsolete-tag warning.
Effect on the reviewer-facing landing pages
───────────────────────────────────────────
Every improvement to a `\file` brief at the top of a public header now
flows automatically into both:
* the Doxygen HTML at https://tmoussa.codeberg.page/ConformalLabpp/
* the markdown landing at doc/api/headers.md (rendered by Codeberg
in the repo view)
…so writers have a single source of truth (the C++ source) and
readers see the same words in both surfaces.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
97 lines
3.6 KiB
YAML
97 lines
3.6 KiB
YAML
name: Doxygen → Codeberg Pages
|
|
|
|
# Auto-publish Doxygen HTML to https://tmoussa.codeberg.page/ConformalLabpp/
|
|
# every time the public API or docs source changes on main.
|
|
#
|
|
# Pattern: mirrors mirror-to-codeberg.yml — reuses the existing
|
|
# CODEBERG_TOKEN secret + HTTPS push. No new secret setup required.
|
|
#
|
|
# Trigger: push to main that touches code/include/**, Doxyfile, the
|
|
# filter script, doc/**/*.md, README.md, or this workflow file. Also
|
|
# manually triggerable via workflow_dispatch.
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- "code/include/**"
|
|
- "Doxyfile"
|
|
- "scripts/doxygen-md-filter.sh"
|
|
- "doc/**/*.md"
|
|
- "README.md"
|
|
- "CLAUDE.md"
|
|
- ".gitea/workflows/doxygen-pages.yml"
|
|
workflow_dispatch: {}
|
|
|
|
jobs:
|
|
publish:
|
|
runs-on: eulernest
|
|
container:
|
|
image: git.eulernest.eu/conformallab/ci-cpp:latest
|
|
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- name: Configure CMake (Doxygen target only — no compiler needed)
|
|
run: cmake -S code -B build
|
|
|
|
- name: Build Doxygen HTML
|
|
run: |
|
|
cmake --build build --target doc
|
|
test -f doc/doxygen/html/index.html
|
|
warnings=$(wc -l < doc/doxygen/doxygen-warnings.log)
|
|
echo "DOC ▸ Doxygen warnings: $warnings"
|
|
if [ "$warnings" -gt 0 ]; then
|
|
echo "::warning::Doxygen produced $warnings warning(s) — review doc/doxygen/doxygen-warnings.log"
|
|
head -30 doc/doxygen/doxygen-warnings.log
|
|
fi
|
|
|
|
- name: Report Doxygen coverage
|
|
run: bash scripts/doxygen-coverage.sh
|
|
|
|
- name: Regenerate doc/api/headers.md from XML
|
|
run: |
|
|
python3 scripts/gen-headers-md.py
|
|
# If the auto-generated headers.md drifted from main, note it.
|
|
# This job runs on every main push so a drift only persists
|
|
# for the duration of one push — the next push that lands
|
|
# will fold the new headers.md back into main (via the
|
|
# codeberg pages branch). For deterministic regeneration
|
|
# within main itself, run `bash scripts/regen-docs.sh`
|
|
# locally before pushing.
|
|
if ! git diff --quiet -- doc/api/headers.md; then
|
|
echo "::warning::doc/api/headers.md drifted — run scripts/regen-docs.sh locally and commit before next push"
|
|
git --no-pager diff -- doc/api/headers.md | head -30
|
|
fi
|
|
|
|
- name: Publish HTML to codeberg pages branch
|
|
env:
|
|
CODEBERG_TOKEN: ${{ secrets.CODEBERG_TOKEN }}
|
|
run: |
|
|
set -eu
|
|
# Build the publish payload in a clean scratch dir so the
|
|
# orphan branch contains only the Doxygen output (and a
|
|
# marker README), never any build/source artefacts.
|
|
publish_dir=$(mktemp -d)
|
|
cp -r doc/doxygen/html/. "$publish_dir/"
|
|
|
|
cat > "$publish_dir/README.txt" <<EOF
|
|
conformallab++ — Doxygen HTML API documentation.
|
|
Auto-generated by .gitea/workflows/doxygen-pages.yml from
|
|
commit ${GITHUB_SHA:-$(git rev-parse HEAD)} on $(date -Iseconds).
|
|
Source: https://codeberg.org/TMoussa/ConformalLabpp
|
|
EOF
|
|
|
|
cd "$publish_dir"
|
|
git init -q -b pages
|
|
git config user.email "ci@eulernest"
|
|
git config user.name "conformallab CI"
|
|
git add -A
|
|
git commit -q -m "Auto-publish: Doxygen HTML for ${GITHUB_SHA:-HEAD}"
|
|
# Force-push: the pages branch is a publish target, history
|
|
# is not interesting (we only ever serve the latest snapshot).
|
|
git push -f \
|
|
"https://TMoussa:${CODEBERG_TOKEN}@codeberg.org/TMoussa/ConformalLabpp.git" \
|
|
pages:pages
|