From aded1a2c703fab75a93aaffbf5d7b0585a9d3ac4 Mon Sep 17 00:00:00 2001 From: Nikolay Tyukaev Date: Fri, 25 Mar 2022 20:22:43 +0300 Subject: [PATCH] a bunch of doc fixes (#11230) (#11237) --- docs/doxyrest-config.lua | 2 +- docs/scripts/doxy_md_filter.py | 2 +- docs/scripts/prepare_xml.py | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/doxyrest-config.lua b/docs/doxyrest-config.lua index 1c420e04da3..998a9ab7c37 100644 --- a/docs/doxyrest-config.lua +++ b/docs/doxyrest-config.lua @@ -161,7 +161,7 @@ VERBATIM_TO_CODE_BLOCK = "cpp" --! reStructuredText (asterisks are used to mark **bold** or *italic* blocks). --! -ESCAPE_ASTERISKS = true +ESCAPE_ASTERISKS = false --! --! If the original doxy comments contain pipe characters ``|``, they have to be diff --git a/docs/scripts/doxy_md_filter.py b/docs/scripts/doxy_md_filter.py index 12395b8833c..1bb84a8acf0 100644 --- a/docs/scripts/doxy_md_filter.py +++ b/docs/scripts/doxy_md_filter.py @@ -127,7 +127,7 @@ class DoxyMDFilter: reference_links = set(re.findall(REFERENCE_LINKS_PATTERN, self.content)) md_links = inline_links md_links.update(reference_links) - return md_links + return sorted(md_links, key=len, reverse=True) def get_label(file): diff --git a/docs/scripts/prepare_xml.py b/docs/scripts/prepare_xml.py index 5901dc66422..0a1db66a570 100644 --- a/docs/scripts/prepare_xml.py +++ b/docs/scripts/prepare_xml.py @@ -25,6 +25,8 @@ def prepare_xml(xml_dir: Path): if matches: for match in matches: contents = contents.replace(match, saxutils.escape(match)) + # escape asterisks + contents = contents.replace('*', '\\*') contents = str.encode(contents) root = etree.fromstring(contents) anchors = root.xpath('//anchor')