feat: Add script to link docs to workspace

j3soon · Nov 5, 2024 · a19fd21 · a19fd21
1 parent 030f593
commit a19fd21
Show file tree

Hide file tree

Showing 14 changed files with 78 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -61,11 +61,10 @@ mkdocs serve
 # Go to https://127.0.0.1:8000 to view the site.
 ```
 
-## Linking the README
+## Link Documentation to ROS2 Workspaces
 
 ```sh
-rm docs/index.md
-ln "${PWD}/README.md" docs/index.md
+scripts/setup_link.sh
 ```
 
 ## Acknowledgement

diff --git a/aloha_ws/.gitignore b/aloha_ws/.gitignore
@@ -6,6 +6,9 @@
 /install
 /log
 
+# Soft Links
+/docs
+
 # Custom ignores
 /isaacsim/assets
 /src/interbotix_ros_manipulators/interbotix_ros_xsarms/interbotix_xsarm_descriptions/urdf/*.urdf
diff --git a/cartographer_ws/.gitignore b/cartographer_ws/.gitignore
@@ -5,3 +5,6 @@
 /build
 /install
 /log
+
+# Soft Links
+/docs
diff --git a/docs/index.md b/docs/index.md
@@ -61,11 +61,10 @@ mkdocs serve
 # Go to https://127.0.0.1:8000 to view the site.
 ```
 
-## Linking the README
+## Link Documentation to ROS2 Workspaces
 
 ```sh
-rm docs/index.md
-ln "${PWD}/README.md" docs/index.md
+scripts/setup_link.sh
 ```
 
 ## Acknowledgement

diff --git a/gazebo_world_ws/.gitignore b/gazebo_world_ws/.gitignore
@@ -5,3 +5,6 @@
 /build
 /install
 /log
+
+# Soft Links
+/docs
diff --git a/husky_ws/.gitignore b/husky_ws/.gitignore
@@ -5,3 +5,6 @@
 /build
 /install
 /log
+
+# Soft Links
+/docs
diff --git a/kobuki_ws/.gitignore b/kobuki_ws/.gitignore
@@ -5,3 +5,6 @@
 /build
 /install
 /log
+
+# Soft Links
+/docs
diff --git a/orbslam3_ws/.gitignore b/orbslam3_ws/.gitignore
@@ -6,6 +6,9 @@
 /install
 /log
 
+# Soft Links
+/docs
+
 # ROS2 bag files
 V1_02_medium.bag
 V1_02_medium/
diff --git a/ros1_bridge_ws/.gitignore b/ros1_bridge_ws/.gitignore
@@ -0,0 +1,10 @@
+# Visual Studio Code
+.vscode
+
+# ROS2 basic directories
+/build
+/install
+/log
+
+# Soft Links
+/docs
diff --git a/rtabmap_ws/.gitignore b/rtabmap_ws/.gitignore
@@ -5,3 +5,6 @@
 /build
 /install
 /log
+
+# Soft Links
+/docs
diff --git a/scripts/setup_link.sh b/scripts/setup_link.sh
@@ -0,0 +1,34 @@
+#!/bin/bash -e
+
+# Get the directory of this script.
+# Reference: https://stackoverflow.com/q/59895
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd)"
+
+cd "$SCRIPT_DIR/.."
+
+workspaces=(
+    "template_ws"
+    "orbslam3_ws"
+    "rtabmap_ws"
+    "ros1_bridge_ws"
+    "cartographer_ws"
+    "husky_ws"
+    "kobuki_ws"
+    "vlp_ws"
+    "gazebo_world_ws"
+    "aloha_ws"
+)
+
+# Link docs index
+rm docs/index.md || true
+ln "${PWD}/README.md" docs/index.md
+
+# Loop through each workspace and link its docs
+for ws in "${workspaces[@]}"
+do
+    ws_hyphen="$(echo $ws | sed "s/_/-/g")"
+    rm "${ws}/docs" || true
+    ln -s "${PWD}/docs/${ws_hyphen}" "${ws}/docs"
+done
+
+echo "Done."
diff --git a/template_ws/.gitignore b/template_ws/.gitignore
@@ -5,3 +5,6 @@
 /build
 /install
 /log
+
+# Soft Links
+/docs
diff --git a/tests/diff_base/.gitignore b/tests/diff_base/.gitignore
@@ -5,4 +5,7 @@
 /build
 /install
 /log
+
+# Soft Links
+/docs
 {PLACEHOLDER_MULTILINE}
diff --git a/vlp_ws/.gitignore b/vlp_ws/.gitignore
@@ -5,3 +5,6 @@
 /build
 /install
 /log
+
+# Soft Links
+/docs
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,3 +5,6 @@ @@
     /build
     /install
     /log
+    # Soft Links
+    /docs