make the docs build failures print a nicer message

mattip · mattip · commit 7cfc7300d3ff · 2021-01-10T23:58:50.000+02:00
diff --git a/.circleci/scripts/python_doc_push_script.sh b/.circleci/scripts/python_doc_push_script.sh
@@ -42,6 +42,26 @@ fi
 
 echo "install_path: $install_path  version: $version"
 
+build_docs () {
+  set +e
+  set -o pipefail
+  make $1 2>&1 | tee /tmp/docs_build.txt
+  code=$?
+  if [ $code -ne 0 ]; then
+    set +x
+    echo =========================
+    grep "WARNING:" /tmp/docs_build.txt
+    echo =========================
+    echo Docs build failed. If the failure is not clear, scan back in the log
+    echo for any WARNINGS or for the line "build finished with problems"
+    echo "(tried to echo the WARNINGS above the ==== line)"
+    echo =========================
+  fi
+  set -ex
+  return $code
+}
+
+
 git clone https://github.com/pytorch/pytorch.github.io -b $branch
 pushd pytorch.github.io
 
@@ -57,7 +77,8 @@ pushd docs
 # Build the docs
 pip -q install -r requirements.txt
 if [ "$is_master_doc" = true ]; then
-  make html
+  build_docs html
+  [ $? -eq 0 ] || exit $?
   make coverage
   # Now we have the coverage report, we need to make sure it is empty.
   # Count the number of lines in the file and turn that number into a variable
@@ -78,8 +99,9 @@ if [ "$is_master_doc" = true ]; then
     exit 1
   fi
 else
-  # Don't fail the build on coverage problems
-  make html-stable
+  # skip coverage, format for stable or tags
+  build_docs html-stable
+  [ $? -eq 0 ] || exit $?
 fi
 
 # Move them into the docs repo
