starlingx/docs
Code Issues Proposed changes

Substitution check

Browse Source 
Add scan for unexpanded substitutions to post-build html checks.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I4e0263f94cede426a993c5204203f602f63020be
This commit is contained in:
Ron Stone 2021-07-07 07:05:21 -04:00
parent 01df660f89
commit da45342b39
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
htmlChecks.sh
View File

@ -7,7 +7,6 @@ NC='\033[0m' # No Color
cd doc/build/html cd doc/build/html
# 1. Check for rST formatting issues that don't cause build warnings/errors
echo "Checking for \"grey bar\" formatting errors in output ..." echo "Checking for \"grey bar\" formatting errors in output ..."
GREY_FILES=( $(grep -rl --include="*.html" "blockquote" .) ) GREY_FILES=( $(grep -rl --include="*.html" "blockquote" .) )
if [ ${#GREY_FILES[@]} != 0 ]; then if [ ${#GREY_FILES[@]} != 0 ]; then
@ -32,6 +31,15 @@ if [ ${#INCLUDE_FILES[@]} != 0 ]; then
error=1 error=1
fi fi
echo "Checking for unexpanded substitution errors in output ..."
INCLUDE_FILES=( $(grep -rl --include="*.html" ' |\S*| ' .) )
if [ ${#INCLUDE_FILES[@]} != 0 ]; then
echo -e "Found ${#INCLUDE_FILES[@]} HTML file(s) that may have unexpanded substitution(s):\n${RED}"
grep -r --include="*.html" ' |\S*| ' . | awk -F: '{if(f!=$1)print ""; f=$1; print $0;}'
echo -e "${NC}\nCorrect the issue(s) in the corresponding rST file(s).\nHINT: Substitions are not allowed in code blocks, :ref:s,\n:doc:s, or within rST markup such as **, \`\`, and so on."
error=1
fi
# Set -W to halt tox # Set -W to halt tox
if [[ $1 == "-W" ]] && [[ ${error} -eq 1 ]]; then if [[ $1 == "-W" ]] && [[ ${error} -eq 1 ]]; then
exit 1 exit 1