diff --git a/doc/source/updates/kubernetes/performing-an-orchestrated-upgrade-using-the-cli.rst b/doc/source/updates/kubernetes/performing-an-orchestrated-upgrade-using-the-cli.rst index fc5188b3c..9993dbca2 100644 --- a/doc/source/updates/kubernetes/performing-an-orchestrated-upgrade-using-the-cli.rst +++ b/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 \ No newline at end of file + :start-after: Orchupgradecli-begin + :end-before: Orchupgradecli-end diff --git a/doc/source/updates/kubernetes/performing-an-orchestrated-upgrade.rst b/doc/source/updates/kubernetes/performing-an-orchestrated-upgrade.rst index 3b5dc676f..7c8db7413 100644 --- a/doc/source/updates/kubernetes/performing-an-orchestrated-upgrade.rst +++ b/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 \ No newline at end of file + :start-after: Orchupgrade-begin + :end-before: Orchupgrade-end diff --git a/doc/source/updates/kubernetes/upgrading-all-in-one-duplex-or-standard.rst b/doc/source/updates/kubernetes/upgrading-all-in-one-duplex-or-standard.rst index c9b9dd900..ef495a517 100644 --- a/doc/source/updates/kubernetes/upgrading-all-in-one-duplex-or-standard.rst +++ b/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 diff --git a/doc/source/updates/kubernetes/upgrading-all-in-one-simplex.rst b/doc/source/updates/kubernetes/upgrading-all-in-one-simplex.rst index 630647b16..79f340b65 100644 --- a/doc/source/updates/kubernetes/upgrading-all-in-one-simplex.rst +++ b/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 diff --git a/htmlChecks.sh b/htmlChecks.sh index 65b5b68c2..824301d53 100755 --- a/htmlChecks.sh +++ b/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