From a3bd201cc72c504f2969c01a368b6698f4d6df57 Mon Sep 17 00:00:00 2001
From: Hugo Locurcio <hugo.locurcio@hugo.pro>
Date: Wed, 27 May 2020 22:24:15 +0200
Subject: [PATCH] makerst: Print status messages to make the CI output clearer

This also removes an unused method.

(cherry picked from commit 9065b7ed4e72d107362a55a1d2b3ded20ae3a32f)
---
 doc/tools/makerst.py | 72 ++++----------------------------------------
 1 file changed, 6 insertions(+), 66 deletions(-)

diff --git a/doc/tools/makerst.py b/doc/tools/makerst.py
index 13bf0989404..883bf5bf132 100755
--- a/doc/tools/makerst.py
+++ b/doc/tools/makerst.py
@@ -276,6 +276,8 @@ def main():  # type: () -> None
     group.add_argument("--dry-run", action="store_true", help="If passed, no output will be generated and XML files are only checked for errors.")
     args = parser.parse_args()
 
+    print("Checking for errors in the XML class reference...")
+
     file_list = []  # type: List[str]
 
     for path in args.path:
@@ -334,7 +336,10 @@ def main():  # type: () -> None
         state.current_class = class_name
         make_rst_class(class_def, state, args.dry_run, args.output)
 
-    if state.errored:
+    if not state.errored:
+        print("No errors found.")
+    else:
+        print("Errors were found in the class reference XML. Please check the messages above.")
         exit(1)
 
 def make_rst_class(class_def, state, dry_run, output_dir):  # type: (ClassDef, State, bool, str) -> None
@@ -549,71 +554,6 @@ def make_rst_class(class_def, state, dry_run, output_dir):  # type: (ClassDef, S
                 index += 1
 
 
-def make_class_list(class_list, columns):  # type: (List[str], int) -> None
-    # This function is no longer used.
-    f = open('class_list.rst', 'w', encoding='utf-8')
-    col_max = len(class_list) // columns + 1
-    print(('col max is ', col_max))
-    fit_columns = []  # type: List[List[str]]
-
-    for _ in range(0, columns):
-        fit_columns.append([])
-
-    indexers = []  # type List[str]
-    last_initial = ''
-
-    for idx, name in enumerate(class_list):
-        col = idx // col_max
-        if col >= columns:
-            col = columns - 1
-        fit_columns[col].append(name)
-        idx += 1
-        if name[:1] != last_initial:
-            indexers.append(name)
-        last_initial = name[:1]
-
-    row_max = 0
-    f.write("\n")
-
-    for n in range(0, columns):
-        if len(fit_columns[n]) > row_max:
-            row_max = len(fit_columns[n])
-
-    f.write("| ")
-    for n in range(0, columns):
-        f.write(" | |")
-
-    f.write("\n")
-    f.write("+")
-    for n in range(0, columns):
-        f.write("--+-------+")
-    f.write("\n")
-
-    for r in range(0, row_max):
-        s = '+ '
-        for c in range(0, columns):
-            if r >= len(fit_columns[c]):
-                continue
-
-            classname = fit_columns[c][r]
-            initial = classname[0]
-            if classname in indexers:
-                s += '**' + initial + '** | '
-            else:
-                s += ' | '
-
-            s += '[' + classname + '](class_' + classname.lower() + ') | '
-
-        s += '\n'
-        f.write(s)
-
-    for n in range(0, columns):
-        f.write("--+-------+")
-    f.write("\n")
-
-    f.close()
-
-
 def escape_rst(text, until_pos=-1):  # type: (str) -> str
     # Escape \ character, otherwise it ends up as an escape character in rst
     pos = 0