This commit is contained in:
CaCO3
2025-04-23 00:30:18 +02:00
parent 771ab515aa
commit 75fe795b5e
2 changed files with 9 additions and 4 deletions

View File

@@ -14,6 +14,9 @@ theme:
palette: palette:
primary: blue primary: blue
validation:
links:
unrecognized_links: ignore # see https://www.mkdocs.org/user-guide/configuration/
plugins: plugins:
- search - search

View File

@@ -22,6 +22,7 @@ def appendParameterFile(section, file, parameterName):
sectionText = "Section: " + "[" + section + "](#section-" + section.lower() +")" sectionText = "Section: " + "[" + section + "](#section-" + section.lower() +")"
parameterDoc = parameterDoc.replace("Default Value:", sectionText + "\n\n" + "Default Value:") # Add section to each parameter parameterDoc = parameterDoc.replace("Default Value:", sectionText + "\n\n" + "Default Value:") # Add section to each parameter
parameterDoc = parameterDoc.replace("[here](../datasheets", "[here](datasheets") # move all datasheet links a level higher
# Add parameter doc to overview page # Add parameter doc to overview page
with open(docsMainFolder + "/" + parameterOverviewFile, 'a') as overviewFileHandle: with open(docsMainFolder + "/" + parameterOverviewFile, 'a') as overviewFileHandle:
@@ -86,14 +87,15 @@ for section in sectionsLogicallyOrdered:
overviewFileHandle.write("\n## Section `%s`\n\n" % section) overviewFileHandle.write("\n## Section `%s`\n\n" % section)
files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + section + '/*'))) files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + section + '/*')))
for file in files: for filename in files:
if not ".md" in file: # Skip non-markdown files if not ".md" in filename: # Skip non-markdown files
continue continue
# Remove "<NUMBER>" from filename
# print(" %s" % file) # print(" %s" % file)
parameter = file.split("/")[-1].replace(".md", "") parameter = filename.split("/")[-1].replace(".md", "")
parameter = parameter.replace("<", "").replace(">", "") parameter = parameter.replace("<", "").replace(">", "")
appendParameterFile(section, file, parameter) appendParameterFile(section, filename, parameter)
""" """