From 7b43167e062af512592e922a58f2ac92ebf6da28 Mon Sep 17 00:00:00 2001
From: Martin Schroschk <martin.schroschk@tu-dresden.de>
Date: Mon, 6 Mar 2023 13:37:20 +0100
Subject: [PATCH] Get rid of argument
Resolve path automatically.
---
doc.zih.tu-dresden.de/util/check_TOC.py | 68 ++++++++++++++-----------
1 file changed, 38 insertions(+), 30 deletions(-)
diff --git a/doc.zih.tu-dresden.de/util/check_TOC.py b/doc.zih.tu-dresden.de/util/check_TOC.py
index 3533cfa06..03c0027fb 100644
--- a/doc.zih.tu-dresden.de/util/check_TOC.py
+++ b/doc.zih.tu-dresden.de/util/check_TOC.py
@@ -5,7 +5,7 @@ Provide as an command line argument the path to the mkdocs.yml file.
Author: Michael Bommhardt-Richter
"""
-import os
+import argparse
import sys
from pathlib import Path
@@ -18,7 +18,7 @@ whitelist = ["index.md"] # ["archive"]
def get_heading_in_file(filename, docs_path):
# TODO join path filename
# Read until first level one heading is found
- f = os.path.join(docs_path, "docs", filename)
+ f = Path.joinpath(docs_path, filename)
with open(f, "r") as file:
for line in file:
if line.startswith("#"):
@@ -28,39 +28,47 @@ def get_heading_in_file(filename, docs_path):
def main():
- with open(sys.argv[1], "r") as file:
- c = file.readlines()
+ scriptpath = Path(__file__).resolve().parent
+ mkdocsyaml = Path.joinpath(scriptpath, "../", "mkdocs.yml")
+ if Path.exists(mkdocsyaml):
- docs_path = Path(sys.argv[1]).resolve().parent
- print(docs_path)
+ docs_path = Path.joinpath(scriptpath, "../", "docs")
+ # print(docs_path)
+ with open(mkdocsyaml, "r") as file:
+ c = file.readlines()
- for line in c:
- line = line.rstrip()
+ for line in c:
+ line = line.rstrip()
- # "headline: path/file.md" -> "Headline" = "path/file.md"
- if line.endswith(".md"):
- line = line.split(" - ")[1]
- line = line.split(": ")
+ # "headline: path/file.md" -> "Headline" = "path/file.md"
+ if line.endswith(".md"):
+ line = line.split(" - ")[1]
+ line = line.split(": ")
- key = line[1]
- file_heading = get_heading_in_file(line[1], docs_path)
- TOCData[line[1]] = [line[0], file_heading]
+ key = line[1]
+ file_heading = get_heading_in_file(line[1], docs_path)
+ TOCData[line[1]] = [line[0], file_heading]
- # Check TOC vs heading in corresponding md-file
- cnt = 0
- for key, value in TOCData.items():
- if key in whitelist:
- continue
- if value[0] == "Overview":
- continue
- if value[0] != value[1]:
- cnt += 1
- print(f"{key:<40}{value[0]:<30} != {value[1]}")
- sys.exit(cnt)
+ # Check TOC vs heading in corresponding md-file
+ cnt = 0
+ for key, value in TOCData.items():
+ if key in whitelist:
+ continue
+ if value[0] == "Overview":
+ continue
+ if value[0] != value[1]:
+ cnt += 1
+ print(f"{key:<40}{value[0]:<30} != {value[1]}")
+ sys.exit(cnt)
+ else:
+ print("Error: Could not find mkdocs.yml file.")
+ sys.exit(-1)
if __name__ == "__main__":
- if len(sys.argv) > 1:
- main()
- else:
- print("Missing Parameter. Start with 'python3 check_TOC.py mkdocs.yml'")
+ parser = argparse.ArgumentParser(
+ description="Find differences in TOC and top level headings of md-files."
+ )
+ args = parser.parse_args()
+
+ main()
--
GitLab