utils/docs-build.sh

   1 #!/bin/bash -e
   2
   3 export PATH=$PATH:/usr/local/bin/
   4
   5
   6 SRC_DIR=${SRC_DIR:-docs}
   7 INDEX_RST=${INDEX_RST:-index.rst}
   8 BUILD_DIR=${BUILD_DIR:-build}
   9 OUTPUT_DIR=${OUTPUT_DIR:-output}
  10 RELENG_DIR=${RELENG_DIR:-releng}
  11 GERRIT_COMMENT=${GERRIT_COMMENT:-}
  12
  13 get_title_script="
  14 import os
  15 from docutils import core, nodes
  16
  17 try:
  18     with open('index.rst', 'r') as file:
  19         data = file.read()
  20     doctree = core.publish_doctree(data,
  21         settings_overrides={'report_level': 5,
  22                             'halt_level': 5})
  23     if isinstance(doctree[0], nodes.title):
  24         title = doctree[0]
  25     else:
  26         for c in doctree.children:
  27             if isinstance(c, nodes.section):
  28                 title = c[0]
  29                 break
  30     print title.astext()
  31 except:
  32     print 'None'"
  33 revision="$(git rev-parse --short HEAD)"
  34 rev_full="$(git rev-parse HEAD)"
  35 version="$(git describe --abbrev=0 2> /dev/null || echo draft) ($revision)"
  36 project="$(basename $(git rev-parse --show-toplevel))"
  37 html_notes="\n    Revision: $rev_full\n\n    Build date: |today|"
  38 default_conf='releng/docs/etc/conf.py'
  39 opnfv_logo='releng/docs/etc/opnfv-logo.png'
  40
  41 function check_rst_doc() {
  42     _src="$1"
  43
  44     if ! which doc8 > /dev/null ; then
  45         echo "Error: 'doc8' not found. Exec 'sudo pip install doc8' first."
  46         exit 1
  47     fi
  48     # Note: This check may fail in many jobs for building project docs, since
  49     #       the old sample has lines more than 120. We ignore failures on this
  50     #       check right now, but these have to be fixed before OPNFV B release.
  51     _out=$(doc8 --max-line-length 120 "$_src") || {
  52         _msg='Error: rst validatino (doc8) has failed, please fix the following error(s).'
  53         _errs=$(echo "$_out" | sed -n -e "/^$_src/s/^/    /p")
  54         echo
  55         echo -e "$_msg\n$_errs"
  56         echo
  57         [[ -n "$GERRIT_COMMENT" ]] && echo -e "$_msg\n$_errs" >> "$GERRIT_COMMENT"
  58     }
  59 }
  60
  61 function add_html_notes() {
  62     _src="$1"
  63     _dir="$2"
  64
  65     if grep -q -e ' _sha1_' "$_src"/*.rst ; then
  66         # TODO: remove this, once old templates were removed from all repos.
  67         echo
  68         echo "Warn: '_sha1_' was found in $_dir , use the latest document template."
  69         echo "      See https://wiki.opnfv.org/documentation/tools ."
  70         echo
  71         sed -i "s/ _sha1_/ $git_sha1/g" "$_src"/*.rst
  72     fi
  73     sed -i -e "\$a\\\n.. only:: html\n$html_notes" "$_src"/*.rst
  74 }
  75
  76 function add_config() {
  77     _conf="$1"
  78     _param="$2"
  79     _val="$3"
  80
  81     if ! grep -q -e "^$_param = " "$_conf" ; then
  82         echo "Adding '$_param' into $_conf ..."
  83         echo "$_param = $_val" >> "$_conf"
  84     fi
  85 }
  86
  87
  88 check_rst_doc $SRC_DIR
  89
  90 if [[ ! -d "$RELENG_DIR" ]] ; then
  91     echo "Error: $RELENG_DIR dir not found. See https://wiki.opnfv.org/documentation/tools ."
  92     exit 1
  93 fi
  94
  95 find $SRC_DIR -name $INDEX_RST -printf '%h\n' | while read dir
  96 do
  97     name="${dir##*/}"
  98     src="$BUILD_DIR/src/$name"
  99     build="$BUILD_DIR/$name"
 100     output="$OUTPUT_DIR/$name"
 101     conf="$src/conf.py"
 102
 103     echo
 104     echo "#################${dir//?/#}"
 105     echo "Building DOCS in $dir"
 106     echo "#################${dir//?/#}"
 107     echo
 108
 109     mkdir -p "$BUILD_DIR/src"
 110     [[ -e "$src" ]] && rm -rf "$src"
 111     cp -r "$dir" "$src"
 112
 113     add_html_notes "$src" "$dir"
 114
 115     [[ ! -f "$conf" ]] && cp "$default_conf" "$conf"
 116     title=$(cd $src; python -c "$get_title_script")
 117     latex_conf="[('index', '$name.tex', \"$title\", 'OPNFV', 'manual'),]"
 118     add_config "$conf" 'latex_documents' "$latex_conf"
 119     add_config "$conf" 'release' "u'$version'"
 120     add_config "$conf" 'version' "u'$version'"
 121     add_config "$conf" 'project' "u'$project'"
 122     add_config "$conf" 'copyright' "u'$(date +%Y), OPNFV'"
 123     cp -f $opnfv_logo "$src/opnfv-logo.png"
 124
 125     mkdir -p "$output"
 126
 127     sphinx-build -b html -t html -E "$src" "$output"
 128
 129     # Note: PDF creation may fail in project doc builds.
 130     #       We allow this build job to be marked as succeeded with
 131     #       failure in PDF creation, but leave message to fix it.
 132     #       Any failure has to be fixed before OPNFV B release.
 133     {
 134         sphinx-build -b latex -t pdf -E "$src" "$build" && \
 135             make -C "$build" LATEXOPTS='--interaction=nonstopmode' all-pdf
 136     } && {
 137         mv "$build/$name.pdf" "$output"
 138     } || {
 139         msg="Error: PDF creation for $dir has failed, please fix source rst file(s)."
 140         echo
 141         echo "$msg"
 142         echo
 143         [[ -n "$GERRIT_COMMENT" ]] && echo "$msg" >> "$GERRIT_COMMENT"
 144     }
 145
 146 done