Add install and loop options to build_locally.sh (#278)

davetcoleman · web-flow · commit 2f944fb74eb7 · 2022-01-14T19:37:49.000+01:00
diff --git a/Makefile b/Makefile
@@ -14,5 +14,7 @@ multiversion: Makefile
 	@echo "<html><head><meta http-equiv=\"refresh\" content=\"0; url=foxy/index.html\" /></head></html>" > build/html/index.html
 
 .PHONY: help Makefile multiversion
+
+# By default this is the 'html' build
 %: Makefile
 	@$(BUILD) -M $@ "$(SOURCE)" "$(OUT)" $(OPTS)
diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@ Below are some links to help with the ports.
 
 Follow the [MoveIt 2 Source Build](https://moveit.ros.org/install-moveit2/source/) instructions to setup a colcon workspace with moveit2 from source.
 
-Cd into your moveit2 colcon workspace:
+Open a command line to your your moveit2 colcon workspace:
 
     cd $COLCON_WS/src
 
@@ -64,6 +64,11 @@ If you want to test the tutorials by generating the html pages locally on your m
 
 The local website ``<LOCAL_PACKAGE_PATH>/build/html/index.html`` should automatically open in your web browser.
 
+### Optional build_locally Settings
+
+ - *noinstall* skip the dependencies install step to speed up the script
+ - *loop* automatically rebuild the html if a change is detected
+
 ## Contributing
 
 We rely on the community to keep these tutorials up to date and bug free. If you find an issue with the tutorials please [open an issue on GitHub](https://github.com/ros-planning/moveit2_tutorials/issues/new) or open a PR with proposed changes.
diff --git a/build_locally.sh b/build_locally.sh
@@ -1,13 +1,55 @@
-#!/bin/sh
+#!/bin/bash -eu
 
-# Install dependencies
-pip3 install --user --upgrade -r requirements.txt
+have_loop() {
+  for arg in "$@"; do
+    if [[ "${arg}" == "loop" ]]; then
+      return 0
+    fi
+  done
+  return 1
+}
 
-# Setup Environment
+have_noinstall() {
+  for arg in "$@"; do
+    if [[ "${arg}" == "noinstall" ]]; then
+      return 0
+    fi
+  done
+  return 1
+}
+
+if [[ "$0" != "${BASH_SOURCE}" ]]; then
+  {
+    echo "This file is meant to be executed, not 'source'd:"
+    echo
+    echo "    ./${BASH_SOURCE}"
+  } >&2
+  return 1
+fi
+
+################################################################################
+# Begin Main Script
+################################################################################
+
+# Install dependencies, unless argument says to skip
+if ! have_noinstall "$@"; then
+  pip3 install --user --upgrade -r requirements.txt
+fi
+
+# A fresh build is required because changes to some components such as css files does not rebuilt currently
+# See issue https://github.com/sphinx-doc/sphinx/issues/2090
 rm -rf build
 
 # Build
 make html
 
 # Run
-xdg-open ./build/html/index.html
+xdg-open ./build/html/index.html &
+
+# Optional build loop
+if have_loop "$@"; then
+  while inotifywait -re modify,move,create,delete .; do
+    rm -rf build
+    make html
+  done
+fi
