Fix ".. include::"s

Fix several rst files in which malformed _include:: parameters caused rst syntax
to be exposed in builds.
Add check for this issue to html scan performed during build.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I7707614cc9f651914b9fd70c0cb8213d612239b8
Signed-off-by: Ron Stone <ronald.stone@windriver.com>

doc/source/updates/kubernetes/performing-an-orchestrated-upgrade-using-the-cli.rst

@@ -328,5 +328,5 @@ described below to upgrade the remaining nodes of the |prod|.
 .. only:: partner
 
     .. include:: /_includes/performing-an-orchestrated-upgrade-using-the-cli.rest
-    :start-after: Orchupgradecli-begin
-    :end-before: Orchupgradecli-end
+        :start-after: Orchupgradecli-begin
+        :end-before: Orchupgradecli-end

doc/source/updates/kubernetes/performing-an-orchestrated-upgrade.rst

@@ -6,7 +6,9 @@
 Perform an Orchestrated Upgrade
 ===============================
 
-You can perform a partially-Orchestrated Upgrade of a |prod| system using the CLI and Horizon Web interface. Upgrade and stability of the initial controller node must be done manually before using upgrade orchestration to orchestrate the remaining nodes of the |prod|.
+You can perform a partially-Orchestrated Upgrade of a |prod| system using the CLI and Horizon
+Web interface. Upgrade and stability of the initial controller node must be done manually
+before using upgrade orchestration to orchestrate the remaining nodes of the |prod|.
 
 .. rubric:: |context|
 
@@ -173,5 +175,5 @@ For more information, see: :ref:`Perform an Orchestrated Upgrade Using the CLI <
 .. only:: partner
 
     .. include:: /_includes/performing-an-orchestrated-upgrade.rest
-    :start-after: Orchupgrade-begin
-    :end-before: Orchupgrade-end
+       :start-after: Orchupgrade-begin
+       :end-before: Orchupgrade-end

doc/source/updates/kubernetes/upgrading-all-in-one-duplex-or-standard.rst

@@ -503,5 +503,5 @@ of |prod| software.
 .. only:: partner
 
     .. include:: /_includes/upgrading-all-in-one-duplex-or-standard.rest
-    :start-after: upgradeDX-begin
-    :end-before: upgradeDX-end
+        :start-after: upgradeDX-begin
+        :end-before: upgradeDX-end

doc/source/updates/kubernetes/upgrading-all-in-one-simplex.rst

@@ -404,5 +404,5 @@ the system contains more than 5 GBytes of these images, the upgrade start will f
 .. only:: partner
 
    .. include:: /_includes/upgrading-all-in-one-simplex.rest
-   :start-after: upgradeAIO-begin
-   :end-before: upgradeAIO-end
+       :start-after: upgradeAIO-begin
+       :end-before: upgradeAIO-end

htmlChecks.sh

@@ -5,22 +5,36 @@
 RED='\033[0;31m'
 NC='\033[0m' # No Color
 
-cd doc/build
+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 ..."
 GREY_FILES=( $(grep -rl --include="*.html" "blockquote" .) )
 if [ ${#GREY_FILES[@]} != 0 ]; then
-    echo "Found ${#GREY_FILES[@]} file(s):"
+    echo "Found ${#GREY_FILES[@]} HTML file(s) with greybar formatting issues:"
     for FILE in ${GREY_FILES[@]};
     do
         echo -e "${RED}$FILE${NC}"
     done
-    echo "Using a browser, locate vertical grey bars in the left margin of the above file(s), then correct the issue(s) in the cooresponding rST file(s)."
-    # Set -W to halt tox
-    if [[ $1 == "-W" ]]; then
-        exit 1
-    fi
+    echo "Using a browser, locate vertical grey bars in the left margin of the above file(s), then correct the issue(s) in the corresponding rST file(s)."
+    error=1
 fi
 
-# 2. do - check for emdash before option (missing backticks)
+echo "Checking for \".. include::\" errors in output ..."
+INCLUDE_FILES=( $(grep -rl --include="*.html" -e "start-after" -e "end-before" .) )
+if [ ${#INCLUDE_FILES[@]} != 0 ]; then
+    echo "Found ${#INCLUDE_FILES[@]} HTML file(s) with exposed \"start-after\" and \"end-before\" _include argument(s):"
+    for FILE in ${INCLUDE_FILES[@]};
+    do
+        echo -e "${RED}$FILE${NC}"
+    done
+    echo "Correct the issue(s) in the corresponding rST file(s)."
+    error=1
+fi
+
+# Set -W to halt tox
+if [[ $1 == "-W" ]] && [[ ${error} -eq 1 ]]; then
+    exit 1
+elif [[ ${error} -ne 1 ]]; then
+    echo "... OK"
+fi