From 94c5e361fbb229b0cd6853e2102a7d95f1f358b3 Mon Sep 17 00:00:00 2001 From: Berke Güzel Date: Mon, 12 Oct 2026 22:12:02 +0300 Subject: better public interface and doxygen --- docs/doxygen_filter.py | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 docs/doxygen_filter.py (limited to 'docs/doxygen_filter.py') diff --git a/docs/doxygen_filter.py b/docs/doxygen_filter.py new file mode 100644 index 0000000..ed6e6e8 --- /dev/null +++ b/docs/doxygen_filter.py @@ -0,0 +1,24 @@ +#!/usr/bin/env python3 +"""Resolve repository source links to Doxygen reference/example pages. + +Markdown keeps ordinary relative links for repository and installed-document +readers. Doxygen gets @ref links so its standalone HTML has no source-tree URLs. +""" + +from pathlib import Path +import re +import sys + +text = Path(sys.argv[1]).read_text(encoding="utf-8") + + +def reference(match): + label, target = match.groups() + if target.startswith("../include/yasl/") and target.endswith(".h"): + return f"[{label}](@ref {Path(target).name})" + if target.startswith("../examples/") and target.endswith(".c"): + return f"[{label}](@ref {Path(target).name})" + return match.group(0) + + +sys.stdout.write(re.sub(r"\[([^\]]+)\]\(([^)]+)\)", reference, text)) -- cgit v1.2.3