gendocs.sh

   1 #!/bin/bash
   2
   3 OUTFILENAME="Application-Framework-Binder-Guide"
   4
   5 SCRIPT=$(basename $BASH_SOURCE)
   6
   7 VERSION=$(grep '"version":' $(dirname $BASH_SOURCE)/book.json | cut -d'"' -f 4)
   8 [ "$VERSION" != "" ] && OUTFILENAME="${OUTFILENAME}_${VERSION}"
   9
  10
  11 function usage() {
  12         cat <<EOF >&2
  13 Usage: $SCRIPT [options] [pdf|serve|doxygen]
  14
  15 Options:
  16    --debug
  17       enable debug when generating pdf or html documentation
  18    -d|--dry
  19       dry run
  20    -h|--help
  21       get this help
  22
  23 Example:
  24         $SCRIPT pdf
  25
  26 EOF
  27         exit 1
  28 }
  29
  30 function info() {
  31         echo "$@" >&2
  32 }
  33
  34 #default values
  35 DEBUG_FLAG=""
  36 DRY=""
  37 DO_ACTION=""
  38 OUT_DIR=./build
  39
  40 [[ $? != 0 ]] && usage
  41 while [ $# -gt 0 ]; do
  42         case "$1" in
  43                 --debug) DEBUG_FLAG="--log=debug --debug";;
  44                 -d|--dry) DRY=echo;;
  45                 -h|--help) usage;;
  46         pdf | serve | doxygen) DO_ACTION=$1;;
  47                 --) break;;
  48         esac
  49     shift
  50 done
  51
  52 cd $(dirname $0)
  53 ROOTDIR=`pwd -P`
  54
  55 # Create out dir if needed
  56 [ -d $OUT_DIR ] || mkdir -p $OUT_DIR
  57
  58 if [ "$DO_ACTION" = "pdf" -o "$DO_ACTION" = "serve" ]; then
  59     GITBOOK=`which gitbook`
  60     [ "$?" = "1" ] && { echo "You must install gitbook first, using: sudo npm install -g gitbook-cli"; exit 1; }
  61
  62     EBCONV=`which ebook-convert`
  63     [ "$?" = "1" ] && { echo "You must install calibre first, using: 'sudo apt install calibre' or refer to https://calibre-ebook.com/download"; exit 1; }
  64
  65     if [ "$DO_ACTION" = "pdf" ]; then
  66
  67         # Update cover when book.json has been changed
  68         [[ $ROOTDIR/book.json -nt $ROOTDIR/docs/cover.jpg ]] && { echo "Update cover files"; $ROOTDIR/docs/resources/make_cover.sh || exit 1; }
  69
  70             OUTFILE=$OUT_DIR/$OUTFILENAME.pdf
  71         $DRY $GITBOOK pdf $ROOTDIR $OUTFILE $DEBUG_FLAG
  72         [ "$?" = "0" ] && echo "PDF has been successfully generated in $OUTFILE"
  73     else
  74         $DRY $GITBOOK serve $DEBUG_FLAG
  75     fi
  76
  77 elif [ "$DO_ACTION" = "doxygen" ]; then
  78     $DRY cd $OUT_DIR && cmake .. && make doxygen $ROOTDIR/Doxyfile
  79
  80 else
  81     echo "Unknown action !"
  82     usage
  83 fi