do-docs.bash

#!/bin/bash
#
# A convenient script to create documentation
#
set -ue -o pipefail

###############################
# 0. check needed software
###############################
if (! which pandoc ); then
    echo "Please insall pandoc first. Try:"
    echo "  sudo apt install pandoc"
    exit 1
fi

###############################
# 1. Source the underlay
###############################
set +u                          # stop checking undefined variable  
source /opt/ros/humble/setup.bash
set -u                          # re-enable undefined variable check

###############################
# 2. run swarm_control's "docs" target
###############################
colcon build \
       --event-handlers console_cohesion+ \
       --packages-select swarm_control \
       --cmake-target "docs"
##echo "open src/swarm_control/docs/html/index.html"

###############################
# 3. run dynamic_fleet_management's "docs" target
###############################
colcon build \
       --event-handlers console_cohesion+ \
       --packages-select dynamic_fleet_management \
       --cmake-target "docs"
##echo "open src/dynamic_fleet_management/docs/html/index.html"

###############################
# 4. combine all docs
###############################
DOCS_DIR=src/docs/
mkdir -p $DOCS_DIR
cat << "EOF" > $DOCS_DIR/index.md
# ENPM808X Final Project Documentation 

Welcome to ENPM808X final project page.  

Here, you will find all the documentation for this project:

* [swarm_control](../swarm_control/docs/html/index.html)
* [dynamic_fleet_management](../dynamic_fleet_management/docs/html/index.html)

Have a nice day.
EOF
pandoc -f markdown $DOCS_DIR/index.md > $DOCS_DIR/index.html
open $DOCS_DIR/index.html || true