Mirror/AI-on-the-edge-device-docs
1
0
Fork 0
mirror of https://github.com/jomjol/AI-on-the-edge-device-docs.git synced 2025-12-08 20:46:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

.

Browse Source
This commit is contained in:
CaCO3
2023-02-05 21:33:24 +01:00
parent d23f593c76
commit 6faab4de9b
2 changed files with 11 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
param-docs/concat-parameter-pages.py
View File

@@ -12,9 +12,7 @@ parameterDocsFolder = "parameter-pages"
parameterOverviewFile = "../docs/Parameters.md" parameterOverviewFile = "../docs/Parameters.md"
parameterOverviewTemplateFile = "./templates/overview.md" parameterOverviewTemplateFile = "./templates/overview.md"
def appendParameterFile(folder, file): def appendParameterFile(section, file, parameterName):
#print(folder, file)
with open(file, 'r') as parameterFileHandle: with open(file, 'r') as parameterFileHandle:
parameterDoc = parameterFileHandle.read() parameterDoc = parameterFileHandle.read()
parameterDoc = parameterDoc.replace("# ", "### ") # Move all headings 2 level down parameterDoc = parameterDoc.replace("# ", "### ") # Move all headings 2 level down
@@ -22,6 +20,7 @@ def appendParameterFile(folder, file):
# Add parameter doc to overview page # Add parameter doc to overview page
with open(parameterOverviewFile, 'a') as overviewFileHandle: with open(parameterOverviewFile, 'a') as overviewFileHandle:
#overviewFileHandle.write(parameterDoc + "\n\n---\n\n") #overviewFileHandle.write(parameterDoc + "\n\n---\n\n")
overviewFileHandle.write("<a id=%s-%s></a>\n" % (section, parameterName))
overviewFileHandle.write(parameterDoc) overviewFileHandle.write(parameterDoc)
overviewFileHandle.write("\n\n<hr style=\"border:2px solid\">\n\n") overviewFileHandle.write("\n\n<hr style=\"border:2px solid\">\n\n")
@@ -44,9 +43,10 @@ for folder in folders:
files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + folder + '/*'))) files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + folder + '/*')))
for file in files: for file in files:
parameter = ".".join(file.split("/")[-1].split(".")[:-1]) section = folder
anchor = parameter.replace("<", "").replace(">", "").replace(".", "").lower() parameter = file.split("/")[-1].replace(".md", "")
toc += " - [`%s`](#parameter-%s)\n" % (parameter, anchor) parameter = parameter.replace("<", "").replace(">", "")
toc += " - [`%s`](#%s-%s)\n" % (parameter, section, parameter)
with open(parameterOverviewTemplateFile, 'r') as overviewFileHandle: with open(parameterOverviewTemplateFile, 'r') as overviewFileHandle:
overviewFileContent = overviewFileHandle.read() overviewFileContent = overviewFileHandle.read()
@@ -72,4 +72,6 @@ for folder in folders:
files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + folder + '/*'))) files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + folder + '/*')))
for file in files: for file in files:
# print(" %s" % file) # print(" %s" % file)
appendParameterFile(folder, file) parameter = file.split("/")[-1].replace(".md", "")
parameter = parameter.replace("<", "").replace(">", "")
appendParameterFile(folder, file, parameter)

2
param-docs/templates/overview.md
View File

@@ -13,3 +13,5 @@ In such case the functionality gets disabled respectively the default values wil
## List of all Parameters ## List of all Parameters
$TOC $TOC
<hr style="border:2px solid">