From c5bed19d67ebb5f5f16066aa10faebdd7805aadc Mon Sep 17 00:00:00 2001 From: Hamish Willee Date: Wed, 29 Jan 2025 12:35:22 +1100 Subject: [PATCH] Fix up notes in text --- tools/generate_markdown_from_doxygen_xml.py | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/tools/generate_markdown_from_doxygen_xml.py b/tools/generate_markdown_from_doxygen_xml.py index 130ce099c1..a809a89dc7 100755 --- a/tools/generate_markdown_from_doxygen_xml.py +++ b/tools/generate_markdown_from_doxygen_xml.py @@ -215,15 +215,16 @@ def markdown_any_tag(aTag, html=False,para=True,consume=False): #Convert "note" types if aTag.attrib['kind']=='warning' or aTag.attrib['kind']=='note' or aTag.attrib['kind']=='attention': #print('Debug: kind %s' % aTag.attrib['kind']) - noteTypeText=aTag.attrib['kind'].capitalize() + noteTypeText=aTag.attrib['kind'].lower() + if noteTypeText == 'note': # Vitepress expects info blocks + noteTypeText = 'info' if para: - if html: - tag_text='

'+lead_text+''+noteTypeText+': '+child_text+'

'+tail_text - else: # ONLY THIS PATH TESTED (others should not occur, but leaving in as standard. - tag_text='\n\n> **'+noteTypeText+'** '+lead_text.strip()+child_text.strip()+'\n\n'+tail_text.strip() + if html: + tag_text='

'+lead_text+''+noteTypeText+': '+child_text+'

'+tail_text + else: # ONLY THIS PATH TESTED (others should not occur, but leaving in as standard. + tag_text='\n\n::: '+noteTypeText+'\n'+lead_text.strip()+child_text.strip()+'\n:::\n\n'+tail_text.strip() else: #para disabled, render without them. - tag_text='\n\n> **'+noteTypeText+'** '+ lead_text.strip()+child_text.strip()+tail_text.strip() - + tag_text='\n\n::: '+noteTypeText+'\n'+ lead_text.strip()+child_text.strip()+'\n:::\n\n'+tail_text.strip() elif aTag.tag=='verbatim': tag_text='\n\n'+lead_text+child_text+'\n\n'+tail_text