From 60ea4e8f8bf58938d7778e2e27a319cc6aa0c09f Mon Sep 17 00:00:00 2001
From: Florian Albrechtskirchinger <falbrechtskirchinger@gmail.com>
Date: Tue, 6 Sep 2022 18:34:06 +0200
Subject: [PATCH] Exclude internal pages from style check

---
 docs/mkdocs/scripts/check_structure.py | 26 ++++++++++++++++++++++++--
 1 file changed, 24 insertions(+), 2 deletions(-)

diff --git a/docs/mkdocs/scripts/check_structure.py b/docs/mkdocs/scripts/check_structure.py
index 643482af2..874cbbee3 100755
--- a/docs/mkdocs/scripts/check_structure.py
+++ b/docs/mkdocs/scripts/check_structure.py
@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 import glob
 import os.path
@@ -8,6 +8,28 @@ import sys
 warnings = 0
 
 
+def filter_internal(files):
+    try:
+        import mkdocs.utils.meta
+    except ModuleNotFoundError:
+        print('Module mkdocs.utils.meta not found. Cannot exclude internal documentation pages from checks.')
+        return files
+
+    internal_paths = []
+    for file in files:
+        _, data = mkdocs.utils.meta.get_data(file)
+        if data.get('x-nlohmann-json-is-internal', False):
+            internal_paths.append(os.path.dirname(file))
+
+    def parent_of(path, parent):
+        return os.path.commonpath([parent]) == os.path.commonpath([path, parent])
+
+    return [
+        file for file in files
+        if not any(parent_of(file, path) for path in internal_paths)
+    ]
+
+
 def report(rule, location, description):
     global warnings
     warnings += 1
@@ -45,7 +67,7 @@ def check_structure():
         'Version history'
     ]
 
-    files = sorted(glob.glob('api/**/*.md', recursive=True))
+    files = sorted(filter_internal(glob.glob('api/**/*.md', recursive=True)))
     for file in files:
         with open(file) as file_content:
             section_idx = -1                 # the index of the current h2 section