diff options
author | Sebastien Douheret <sebastien.douheret@iot.bzh> | 2018-09-20 10:01:29 +0200 |
---|---|---|
committer | Sebastien Douheret <sebastien.douheret@iot.bzh> | 2018-09-20 10:01:29 +0200 |
commit | 2e4bbe051ab130a3859e0b3c3a4477d7205df6a7 (patch) | |
tree | cafb41d412a3b2b9cf168d4bffb25b4b3f7ad5e4 /gendocs.sh | |
parent | 77973a72cb095f23a1e9bc776582781e8316e265 (diff) |
doc: Changed doc to new format
- split book.json to match new format
- changed description in README.md
- remove useless files
Change-Id: I235c6f033ad12eeac86cab16f4c311e61ca60351
Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
Diffstat (limited to 'gendocs.sh')
-rwxr-xr-x | gendocs.sh | 83 |
1 files changed, 0 insertions, 83 deletions
diff --git a/gendocs.sh b/gendocs.sh deleted file mode 100755 index 833bc16..0000000 --- a/gendocs.sh +++ /dev/null @@ -1,83 +0,0 @@ -#!/bin/bash - -OUTFILENAME="Signal_Composer" - -SCRIPT=$(basename $BASH_SOURCE) - -VERSION=$(grep '"version":' $(dirname $BASH_SOURCE)/book.json | cut -d'"' -f 4) -[ "$VERSION" != "" ] && OUTFILENAME="${OUTFILENAME}_${VERSION}" - - -function usage() { - cat <<EOF >&2 -Usage: $SCRIPT [options] [pdf|serve|doxygen] - -Options: - --debug - enable debug when generating pdf or html documentation - -d|--dry - dry run - -h|--help - get this help - -Example: - $SCRIPT pdf - -EOF - exit 1 -} - -function info() { - echo "$@" >&2 -} - -#default values -DEBUG_FLAG="" -DRY="" -DO_ACTION="" -OUT_DIR=./build - -[[ $? != 0 ]] && usage -while [ $# -gt 0 ]; do - case "$1" in - --debug) DEBUG_FLAG="--log=debug --debug";; - -d|--dry) DRY=echo;; - -h|--help) usage;; - pdf | serve | doxygen) DO_ACTION=$1;; - --) break;; - esac - shift -done - -cd $(dirname $0) -ROOTDIR=`pwd -P` - -# Create out dir if needed -[ -d $OUT_DIR ] || mkdir -p $OUT_DIR - -if [ "$DO_ACTION" = "pdf" -o "$DO_ACTION" = "serve" ]; then - GITBOOK=`which gitbook` - [ "$?" = "1" ] && { echo "You must install gitbook first, using: sudo npm install -g gitbook-cli"; exit 1; } - - EBCONV=`which ebook-convert` - [ "$?" = "1" ] && { echo "You must install calibre first, using: 'sudo apt install calibre' or refer to https://calibre-ebook.com/download"; exit 1; } - - if [ "$DO_ACTION" = "pdf" ]; then - - # Update cover when book.json has been changed - [[ $ROOTDIR/book.json -nt $ROOTDIR/docs/cover.jpg ]] && { echo "Update cover files"; $ROOTDIR/docs/resources/make_cover.sh || exit 1; } - - OUTFILE=$OUT_DIR/$OUTFILENAME.pdf - $DRY $GITBOOK pdf $ROOTDIR $OUTFILE $DEBUG_FLAG - [ "$?" = "0" ] && echo "PDF has been successfully generated in $OUTFILE" - else - $DRY $GITBOOK serve $DEBUG_FLAG - fi - -elif [ "$DO_ACTION" = "doxygen" ]; then - $DRY cd $OUT_DIR && cmake .. && make doxygen $ROOTDIR/Doxyfile - -else - echo "Unknown action !" - usage -fi |