btstack/doc/manual/markdown2mkdocs.py
2021-05-27 14:45:58 +02:00

125 lines
3.9 KiB
Python
Executable File

#!/usr/bin/env python3
import sys, os, shutil, getopt
import re, yaml
# helper to write anchors and references
def insert_anchor(mdout, reference):
anchor = "<a name=\"" + reference + "\"></a>\n\n"
mdout.write(anchor)
def insert_reference(mdout, text, link):
mdout.write("")
# handlers for various elements
def process_section(mdin, mdout, line):
section = re.match('(#+.*){#(sec:.*)}',line)
if section:
insert_anchor(mdout, section.group(2))
mdout.write(section.group(1)+"\n")
line = ''
return line
def process_figure(mdin, mdout, line):
# detect figure
figure = re.match('\s*(\!.*)({#(fig:.*)})',line)
if figure:
insert_anchor(mdout, figure.group(3))
mdout.write(figure.group(1)+"\n")
line = ''
return line
def process_fig_ref(mdin, mdout, line):
# detect figure reference
figure_ref = re.match('.*({@(fig:.*)})',line)
if figure_ref:
md_reference = "[below](#"+figure_ref.group(2)+")"
line = line.replace(figure_ref.group(1), md_reference)
mdout.write(line)
line = ''
return line
def process_table(mdin, mdout, line):
# detect table
table = re.match('\s*(Table:.*)({#(tbl:.*)})',line)
if table:
insert_anchor(mdout, table.group(3))
mdout.write(table.group(1)+"\n")
line = ''
return line
def process_tbl_ref(mdin, mdout, line):
table_ref = re.match('.*({@(tbl:.*)})',line)
if table_ref:
md_reference = "[below](#"+table_ref.group(2)+")"
line = line.replace(table_ref.group(1), md_reference)
mdout.write(line)
line = ''
return line
def process_listing(mdin, mdout, line):
listing_start = re.match('.*{#(lst:.*)\s+.c\s+.*',line)
listing_end = re.match('\s*~~~~\s*\n',line)
if listing_start:
insert_anchor(mdout, listing_start.group(1))
line = ''
elif listing_end:
mdout.write("\n")
line = ''
return line
def main(argv):
markdownfolder = "docs-markdown/"
mkdocsfolder = "docs/"
cmd = 'markdown2mkdocs.py [-i <markdownfolder>] [-o <mkdocsfolder>] '
try:
opts, args = getopt.getopt(argv,"i:o:",["ifolder=","ofolder="])
except getopt.GetoptError:
print (cmd)
sys.exit(2)
for opt, arg in opts:
if opt == '-h':
print (cmd)
sys.exit()
elif opt in ("-i", "--ifolder"):
markdownfolder = arg
elif opt in ("-o", "--ofolder"):
mkdocsfolder = arg
yml_file = "mkdocs.yml"
with open(yml_file, 'r') as yin:
doc = yaml.load(yin, Loader=yaml.SafeLoader)
for page in doc["nav"]:
mk_file = list(page.values())[0]
source_file = markdownfolder +"/"+ mk_file
dest_file = mkdocsfolder +"/"+ mk_file
print("Processing %s -> %s" % (source_file, dest_file))
with open(dest_file, 'w') as mdout:
with open(source_file, 'r') as mdin:
for line in mdin:
line = process_section(mdin, mdout, line)
if len(line) == 0:
continue
line = process_figure(mdin, mdout, line)
if len(line) == 0:
continue
line = process_fig_ref(mdin, mdout, line)
if len(line) == 0:
continue
line = process_table(mdin, mdout, line)
if len(line) == 0:
continue
line = process_tbl_ref(mdin, mdout, line)
if len(line) == 0:
continue
line = process_listing(mdin, mdout, line)
if len(line) == 0:
continue
mdout.write(line)
if __name__ == "__main__":
main(sys.argv[1:])