mirror of
https://github.com/jomjol/AI-on-the-edge-device-docs.git
synced 2025-12-10 13:36:56 +03:00
77 lines
2.6 KiB
Python
77 lines
2.6 KiB
Python
"""
|
|
Grab all parameter files and concat them into a single file.
|
|
The header structure gets moved down 1 level
|
|
"""
|
|
|
|
import os
|
|
import shutil
|
|
import glob
|
|
|
|
|
|
parameterDocsFolder = "parameter-pages"
|
|
parameterOverviewFile = "../docs/Parameters.md"
|
|
parameterOverviewTemplateFile = "./templates/overview.md"
|
|
|
|
def appendParameterFile(section, file, parameterName):
|
|
with open(file, 'r') as parameterFileHandle:
|
|
parameterDoc = parameterFileHandle.read()
|
|
parameterDoc = parameterDoc.replace("# ", "### ") # Move all headings 2 level down
|
|
|
|
# Add parameter doc to overview page
|
|
with open(parameterOverviewFile, 'a') as overviewFileHandle:
|
|
overviewFileHandle.write("<a id=%s-%s></a>\n" % (section, parameterName)) # Create a html anchor so we can link to it with "section-parameter"
|
|
overviewFileHandle.write(parameterDoc)
|
|
overviewFileHandle.write("\n\n<hr style=\"border:2px solid\">\n\n")
|
|
|
|
|
|
# Create templated overview markdown file
|
|
if os.path.exists(parameterOverviewFile):
|
|
os.remove(parameterOverviewFile)
|
|
#shutil.copy(parameterOverviewTemplateFile, parameterOverviewFile)
|
|
|
|
folders = sorted( filter( os.path.isdir, glob.glob(parameterDocsFolder + '/*') ) )
|
|
|
|
"""
|
|
Create Overview Page (parameters.md)
|
|
"""
|
|
toc = ""
|
|
for folder in folders:
|
|
folder = folder.split("/")[-1]
|
|
|
|
with open(parameterOverviewTemplateFile, 'r') as overviewFileHandle:
|
|
overviewFileContent = overviewFileHandle.read()
|
|
|
|
# # Create TOC
|
|
# toc += "\n\n[%s](#%s)\n\n" % (folder, folder.lower())
|
|
#
|
|
# files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + folder + '/*')))
|
|
# for file in files:
|
|
# section = folder
|
|
# parameter = file.split("/")[-1].replace(".md", "")
|
|
# parameter = parameter.replace("<", "").replace(">", "")
|
|
# toc += " - [`%s`](#%s-%s)\n" % (parameter, section, parameter)
|
|
#
|
|
# overviewFileContent = overviewFileContent.replace("$TOC", toc)
|
|
|
|
with open(parameterOverviewFile, 'w') as overviewFileHandle:
|
|
overviewFileHandle.write(overviewFileContent)
|
|
|
|
|
|
"""
|
|
Append all parameter pages in a sorted manner
|
|
"""
|
|
for folder in folders:
|
|
folder = folder.split("/")[-1]
|
|
# print(folder)
|
|
|
|
# Add section
|
|
with open(parameterOverviewFile, 'a') as overviewFileHandle:
|
|
overviewFileHandle.write("\n## Section `%s`\n\n" % folder)
|
|
|
|
files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + folder + '/*')))
|
|
for file in files:
|
|
# print(" %s" % file)
|
|
parameter = file.split("/")[-1].replace(".md", "")
|
|
parameter = parameter.replace("<", "").replace(">", "")
|
|
appendParameterFile(folder, file, parameter)
|