From e8715aec5e05e0438192e611afea2fe6f10cb80f Mon Sep 17 00:00:00 2001 From: Aylur Date: Fri, 25 Oct 2024 14:09:04 +0000 Subject: docs: battery doc comments --- lib/gir.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) (limited to 'lib/gir.py') diff --git a/lib/gir.py b/lib/gir.py index 9ef680f..a0a81dc 100644 --- a/lib/gir.py +++ b/lib/gir.py @@ -8,6 +8,15 @@ import xml.etree.ElementTree as ET import html import sys import subprocess +import re + + +# valac fails on gi-docgen compliant markdown +# gi-docgen removes valac compliant ulink +# so we use vala notation and turn it into markdown +def ulink_to_markdown(text: str): + pattern = r'(.*?)' + return re.sub(pattern, r"[\2](\1)", text) def fix_gir(name: str, gir: str, out: str): @@ -24,7 +33,7 @@ def fix_gir(name: str, gir: str, out: str): for doc in root.findall(".//doc", namespaces): if doc.text: - doc.text = ( + doc.text = ulink_to_markdown( html.unescape(doc.text).replace("", "").replace("", "") ) -- cgit v1.2.3