summaryrefslogtreecommitdiffstats
path: root/utils/docs-build.sh
diff options
context:
space:
mode:
authorRyota MIBU <r-mibu@cq.jp.nec.com>2015-12-09 00:51:36 +0900
committerRyota MIBU <r-mibu@cq.jp.nec.com>2015-12-14 22:39:47 +0900
commitb9e3d1e36b715316c9b823818cd96fbe4f484618 (patch)
treee2f5b42457c147878154bbb3588e158bf0c9232b /utils/docs-build.sh
parent6cde0e6934096753d95afc2cfc4664279b4b5202 (diff)
Adding doc8 check against rst files
This patch adds checks for trailing whitespace or length (> 120) in rst files. If there is any violation, the result will be posted on gerrit as jenkins comment, but won't turn the job failed. JIRA: RELENG-26 JIRA: RELENG-27 Change-Id: I9261e3d91921877a95eafe0a650d8da46304ef40 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
Diffstat (limited to 'utils/docs-build.sh')
-rwxr-xr-xutils/docs-build.sh22
1 files changed, 22 insertions, 0 deletions
diff --git a/utils/docs-build.sh b/utils/docs-build.sh
index bf9ab5b1e..5ac8b2be6 100755
--- a/utils/docs-build.sh
+++ b/utils/docs-build.sh
@@ -38,6 +38,26 @@ html_notes="\n Revision: $rev_full\n\n Build date: |today|"
default_conf='releng/docs/etc/conf.py'
opnfv_logo='releng/docs/etc/opnfv-logo.png'
+function check_rst_doc() {
+ _src="$1"
+
+ if ! which doc8 > /dev/null ; then
+ echo "Error: 'doc8' not found. Exec 'sudo pip install doc8' first."
+ exit 1
+ fi
+ # Note: This check may fail in many jobs for building project docs, since
+ # the old sample has lines more than 120. We ignore failures on this
+ # check right now, but these have to be fixed before OPNFV B release.
+ _out=$(doc8 --max-line-length 120 "$_src") || {
+ _msg='Error: rst validatino (doc8) has failed, please fix the following error(s).'
+ _errs=$(echo "$_out" | sed -n -e "/^$_src/s/^/ /p")
+ echo
+ echo -e "$_msg\n$_errs"
+ echo
+ [[ -n "$GERRIT_COMMENT" ]] && echo -e "$_msg\n$_errs" >> "$GERRIT_COMMENT"
+ }
+}
+
function add_html_notes() {
_src="$1"
_dir="$2"
@@ -65,6 +85,8 @@ function add_config() {
}
+check_rst_doc $SRC_DIR
+
if [[ ! -d "$RELENG_DIR" ]] ; then
echo "Error: $RELENG_DIR dir not found. See https://wiki.opnfv.org/documentation/tools ."
exit 1