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-09 04:56:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

Added TOC to parameter overview

Browse Source
This commit is contained in:
CaCO3
2023-02-05 16:23:52 +01:00
parent 3a3a17ff08
commit f1ff87357f
5 changed files with 41 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -27,19 +27,44 @@ def appendParameterFile(folder, file):
# Create templated overview markdown file
if os.path.exists(parameterOverviewFile):
os.remove(parameterOverviewFile)
shutil.copy(parameterOverviewTemplateFile, parameterOverviewFile)
#shutil.copy(parameterOverviewTemplateFile, parameterOverviewFile)
folders = sorted( filter( os.path.isdir, glob.glob(parameterDocsFolder + '/*') ) )
"""
Create Table of Content
"""
toc = ""
for folder in folders:
folder = folder.split("/")[-1]
toc += "\n\n[%s](#%s)\n\n" % (folder, folder.lower())
files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + folder + '/*')))
for file in files:
parameter = ".".join(file.split("/")[-1].split(".")[:-1])
anchor = parameter.replace("<", "").replace(">", "").replace(".", "").lower()
toc += " - [`%s`](#parameter-%s)\n" % (parameter, anchor)
with open(parameterOverviewTemplateFile, 'r') as overviewFileHandle:
overviewFileContent = overviewFileHandle.read()
overviewFileContent = overviewFileContent.replace("$TOC", toc)
with open(parameterOverviewFile, 'w') as overviewFileHandle:
overviewFileHandle.write(overviewFileContent)
"""
Append all parameter pages in a sorted manner
"""
folders = sorted( filter( os.path.isdir, glob.glob(parameterDocsFolder + '/*') ) )
for folder in folders:
folder = folder.split("/")[-1]
# print(folder)
# Add section
with open(parameterOverviewFile, 'a') as overviewFileHandle:
overviewFileHandle.write("\n## [%s]\n\n" % folder)
overviewFileHandle.write("\n## Section `%s`\n\n" % folder)
files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + folder + '/*')))
for file in files: