From 6faab4de9b8b80db8079d2037655b8db4345d610 Mon Sep 17 00:00:00 2001 From: CaCO3 Date: Sun, 5 Feb 2023 21:33:24 +0100 Subject: [PATCH] . --- param-docs/concat-parameter-pages.py | 16 +++++++++------- param-docs/templates/overview.md | 2 ++ 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/param-docs/concat-parameter-pages.py b/param-docs/concat-parameter-pages.py index 92a9550..f73968d 100644 --- a/param-docs/concat-parameter-pages.py +++ b/param-docs/concat-parameter-pages.py @@ -12,9 +12,7 @@ parameterDocsFolder = "parameter-pages" parameterOverviewFile = "../docs/Parameters.md" parameterOverviewTemplateFile = "./templates/overview.md" -def appendParameterFile(folder, file): - #print(folder, file) - +def appendParameterFile(section, file, parameterName): with open(file, 'r') as parameterFileHandle: parameterDoc = parameterFileHandle.read() parameterDoc = parameterDoc.replace("# ", "### ") # Move all headings 2 level down @@ -22,6 +20,7 @@ def appendParameterFile(folder, file): # Add parameter doc to overview page with open(parameterOverviewFile, 'a') as overviewFileHandle: #overviewFileHandle.write(parameterDoc + "\n\n---\n\n") + overviewFileHandle.write("\n" % (section, parameterName)) overviewFileHandle.write(parameterDoc) overviewFileHandle.write("\n\n
\n\n") @@ -44,9 +43,10 @@ for folder in folders: 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) + section = folder + parameter = file.split("/")[-1].replace(".md", "") + parameter = parameter.replace("<", "").replace(">", "") + toc += " - [`%s`](#%s-%s)\n" % (parameter, section, parameter) with open(parameterOverviewTemplateFile, 'r') as overviewFileHandle: overviewFileContent = overviewFileHandle.read() @@ -72,4 +72,6 @@ for folder in folders: files = sorted(filter(os.path.isfile, glob.glob(parameterDocsFolder + "/" + folder + '/*'))) for file in files: # print(" %s" % file) - appendParameterFile(folder, file) + parameter = file.split("/")[-1].replace(".md", "") + parameter = parameter.replace("<", "").replace(">", "") + appendParameterFile(folder, file, parameter) diff --git a/param-docs/templates/overview.md b/param-docs/templates/overview.md index c2bd1ff..e7d79ad 100644 --- a/param-docs/templates/overview.md +++ b/param-docs/templates/overview.md @@ -13,3 +13,5 @@ In such case the functionality gets disabled respectively the default values wil ## List of all Parameters $TOC + +
\ No newline at end of file