Disable literal block when linting (#234)

rffontenelle · web-flow · commit 68de5ca52f66 · 2024-10-17T10:06:40.000-03:00
* Disable literal block translation when linting

* Fix exit status for lint.sh

* Simplify error output redirect in lint.sh

To avoid "Syntax error: redirection unexpected"
diff --git a/scripts/lint.sh b/scripts/lint.sh
@@ -18,11 +18,30 @@ cd "$rootdir"
 mkdir -p logs
 touch logs/sphinxlint.txt
 
-cd cpython/Doc/locale/${PYDOC_LANGUAGE}/LC_MESSAGES
-sphinx-lint | tee $(realpath "$rootdir/logs/sphinxlint.txt")
-cd $OLDPWD
+cd cpython/Doc
 
-# Remove empty file
+# Disable literal blocks and update PO
+sed -i "/^\s*'literal-block',/s/ '/ #'/" conf.py
+# TODO: use `make -C .. gettext` when there are only Python >= 3.12
+opts='-E -b gettext -q -D gettext_compact=0 -d build/.doctrees . build/gettext' 
+make build ALLSPHINXOPTS="$opts"
+# Update translation files with latest POT
+sphinx-intl update -d locale -p build/gettext -l ${PYDOC_LANGUAGE} > /dev/null
+
+cd locale/${PYDOC_LANGUAGE}/LC_MESSAGES
+sphinx-lint 2> $(realpath "$rootdir/logs/sphinxlint.txt")
+
+# Undo changes to undo literal blocks disabling
+git checkout .
+
+cd "$rootdir"
+
+# Check of logfile is empty
 if [ ! -s logs/sphinxlint.txt ]; then
+  # OK, it is empty. Remove it.
   rm logs/sphinxlint.txt
+else
+  # print contents and exit with error status (to trigger notification in CI)
+  cat logs/sphinxlint.txt
+  exit 1
 fi
