linting: create linting check

Author: ScatteredComet

.github/workflows/ci.yml

@@ -23,6 +23,9 @@ jobs:
         run: |
           bash ./_tools/check-rst.sh
 
+      - name: Custom RST checks (check_rst_headings.py)
+        run: python3 _tools/check_rst_headings.py
+
       - name: Get Python version
         id: pythonv
         run: |

_tools/check_rst_headings.py

@@ -0,0 +1,38 @@
+import os
+import re
+import sys
+
+def check_headings():
+    search_dir = "tutorials"
+    exclude_path = "tutorials/io/binary_serialization_api.rst"
+    info_message = "Headings which start with a number must have a custom anchor defined before them to prevent malformed link fragments. See here: https://docs.godotengine.org/en/stable/contributing/documentation/docs_writing_guidelines.html \n"
+    
+    pattern = re.compile(r"^(?!\.\. _doc)(.+\n\s*^\d.*\n^[~-].*)", re.M)
+    
+    found_issues = False
+    header_printed = False
+
+    for root, _, files in os.walk(search_dir):
+        for f in files:
+            path = os.path.join(root, f)
+            
+            if not f.endswith(".rst") or path == exclude_path:
+                continue
+            
+            with open(path, "r", encoding="utf-8") as file:
+                content = file.read()
+            
+            for match in pattern.finditer(content):
+                if not header_printed:
+                    print(f"{info_message}\n")
+                    header_printed = True
+                
+                line_no = content[:match.start()].count("\n") + 1
+                print(f"Violation in {path} at line {line_no}:\n{match.group(1)}\n")
+                found_issues = True
+
+    if found_issues:
+        sys.exit(1)
+
+if __name__ == "__main__":
+    check_headings()