Treat all doc/rst warnings as errors (#414)

Signed-off-by: Neil R. Spruit <neil.r.spruit@intel.com>

Author: nrspruit

scripts/generate_docs.py

@@ -14,8 +14,8 @@
 RE_ENABLE   = r"^\#\#\s*\-\-validate\s*\=\s*on$"
 RE_DISABLE  = r"^\#\#\s*\-\-validate\s*\=\s*off$"
 
-RE_PYCODE_BLOCK_BEGIN = r"^\<\%$"
-RE_PYCODE_BLOCK_END   = r"^\%\>$"
+RE_PYCODE_BLOCK_BEGIN = r"^[\ufeff]?\<\%\!?\s*$"
+RE_PYCODE_BLOCK_END   = r"^\%\>\s*$"
 
 RE_INVALID_TAG_FORMAT  = r".*(\$\w).*"
 RE_EXTRACT_TAG_NAME    = r"\$\{(\w)\}"
@@ -113,11 +113,14 @@ def _generate_valid_rst(fin, fout, namespace, tags, ver, rev, meta):
             outlines.append(line)
             continue
 
-        if re.match(RE_INVALID_TAG_FORMAT, line):
-            print("%s(%s) : error : invalid %s tag used"%(fin, iline+1, re.sub(RE_INVALID_TAG_FORMAT, r"\1", line)))
-
         # new line will contain proper tags for reStructuredText if needed
         newline = line
+
+        # Only validate tags when not in code blocks
+        if not code_block and re.match(RE_INVALID_TAG_FORMAT, line):
+            error_msg = "%s(%s) : error : invalid %s tag used"%(fin, iline+1, re.sub(RE_INVALID_TAG_FORMAT, r"\1", line))
+            print(error_msg)
+            util.makeError(error_msg)
         if re.match(RE_PROPER_TAG_FORMAT, line):
             words = re.findall(RE_EXTRACT_NAME, line)
 

scripts/run.py

@@ -12,6 +12,7 @@
 import os, sys, platform
 import time
 import subprocess
+import warnings
 
 """
     helper for adding mutually-exclusive boolean arguments "--name" and "--!name"
@@ -48,7 +49,7 @@ def update_spec(target):
 """
 def build():
     if "Windows" == platform.system():
-        result = os.system('cmake -B ../build/ -S .. -G "Visual Studio 17 2022" -A x64')
+        result = os.system('cmake -B ../build/ -S .. -G "Visual Studio 17 2022" -A x64"')
     else:
         result = os.system('cmake -B ../build/ -S ..')
     if result == 0:
@@ -84,6 +85,9 @@ def revision():
     Do everything...
 """
 def main():
+    # Configure Python to treat warnings as errors
+    warnings.filterwarnings('error')
+
     # phase 0: parse cmdline arguments
     configParser = util.configRead("config.ini")
 
@@ -159,8 +163,9 @@ def main():
                 generate_docs.generate_rst(docpath, config['name'], config['namespace'], config['tags'], args['ver'], args['rev'], specs, input['meta'])
 
         if util.makeErrorCount():
+            util.printAllErrors()
             print("\n%s Errors found during generation, stopping execution!"%util.makeErrorCount())
-            return
+            sys.exit(1)
 
     if args['debug']:
         util.makoFileListWrite("generated.json")

scripts/util.py

@@ -184,6 +184,18 @@ def makoFileListWrite(outpath):
 def makeErrorCount():
     return len(makoErrorList)
 
+def makeError(message):
+    makoErrorList.append(message)
+
+def printAllErrors():
+    if len(makoErrorList) > 0:
+        print("\n" + "="*80)
+        print("ERRORS SUMMARY (%d error(s) found):" % len(makoErrorList))
+        print("="*80)
+        for idx, error in enumerate(makoErrorList, 1):
+            print("%d. %s" % (idx, error))
+        print("="*80)
+
 """
     write to array of string lines to file
 """