Merge pull request #1682 from croth1/beautify_linkcheck_output

Author: beckermr

.ci_scripts/display_linkcheck.py

@@ -0,0 +1,45 @@
+import argparse
+import json
+from collections import defaultdict
+from termcolor import colored
+
+status_colors = dict(
+    broken='red',
+    redirected='yellow',
+    working='green',
+    ignored='white',
+    unchecked='white',
+ )
+
+def create_parser():
+    parser = argparse.ArgumentParser('display_linkcheck')
+    parser.add_argument('linkcheck_json')
+    return parser
+
+
+def main():
+    parser = create_parser()
+    args = parser.parse_args()
+    buffer = defaultdict(list)
+    with open(args.linkcheck_json) as fh:
+        for line in fh:
+            data = json.loads(line)
+            buffer[data['status']].append(data)
+   
+    for status, color in status_colors.items():
+        if status not in buffer:
+            continue
+        for data in buffer[status]:
+            
+            print_tokens = [
+                colored(f'[{data["status"]}]', color),
+                colored(data['uri'], 'magenta'),
+                f'{data["filename"]}:{data["lineno"]}',
+            ]
+            if data['info'] != '':
+                print_tokens.append(f'({data["info"]})')
+
+            print(*print_tokens)
+
+if __name__ == '__main__':
+    main()

.ci_scripts/environment.yml

@@ -16,6 +16,7 @@ dependencies:
   - python-dateutil
   - pip
   - python-rapidjson
+  - termcolor
   # uncomment to restore search
   # - elm
   # - nodejs

.ci_scripts/update_docs

@@ -30,7 +30,10 @@ pushd src
 # -W --keep-going: list all warnings but fail build in case there are any
 # -n: check validity of all links
 make html SPHINXOPTS="-W --keep-going -n"
-make linkcheck
+linkcheck_failed=0
+make linkcheck > /dev/null || linkcheck_failed=1
+python ../.ci_scripts/display_linkcheck.py _build/linkcheck/output.json
+test "$linkcheck_failed" -eq 0
 mv _build/html ../docs
 rm -rf _build
 popd