Merge pull request #46 from ResidenciaTICBrisa/complete-ros-docs

- move ROS to scripts directory - update mkdocs
ResidenciaTICBrisa · Aug 16, 2023 · 6440b03 · 6440b03
2 parents 82e04d2 + 16a7cb4
commit 6440b03
Show file tree

Hide file tree

Showing 46 changed files with 19 additions and 14 deletions.
diff --git a/docs/mkdocs-kludge.sh b/docs/mkdocs-kludge.sh
@@ -6,7 +6,7 @@ for docdir in "${DOCDIRS[@]}"; do
 	# Create directory inside the current one
 	mkdir -pv "${docdir}"
 
-	for f in ../"${docdir}"/*.md; do
+	for f in ../scripts/"${docdir}"/*.md; do
 		# Link relative to the new directory with the same file name
 		ln -sv "../$f" "${docdir}/$(basename "$f")"
 	done

diff --git a/docs/ros1/compiling-for-amd64-based-systems.md b/docs/ros1/compiling-for-amd64-based-systems.md
@@ -1 +1 @@
-../../ros1/compiling-for-amd64-based-systems.md
+../../scripts/ros1/compiling-for-amd64-based-systems.md
diff --git a/docs/ros1/compiling-for-arm-based-systems.md b/docs/ros1/compiling-for-arm-based-systems.md
@@ -1 +1 @@
-../../ros1/compiling-for-arm-based-systems.md
+../../scripts/ros1/compiling-for-arm-based-systems.md
diff --git a/docs/ros1/general-instructions.md b/docs/ros1/general-instructions.md
@@ -1 +1 @@
-../../ros1/general-instructions.md
+../../scripts/ros1/general-instructions.md
diff --git a/docs/ros1/installing-native-packages.md b/docs/ros1/installing-native-packages.md
@@ -1 +1 @@
-../../ros1/installing-native-packages.md
+../../scripts/ros1/installing-native-packages.md
diff --git a/docs/ros1/installing-precompiled-packages.md b/docs/ros1/installing-precompiled-packages.md
@@ -1 +1 @@
-../../ros1/installing-precompiled-packages.md
+../../scripts/ros1/installing-precompiled-packages.md
diff --git a/docs/ros2/compiling-for-amd64-based-systems.md b/docs/ros2/compiling-for-amd64-based-systems.md
@@ -1 +1 @@
-../../ros2/compiling-for-amd64-based-systems.md
+../../scripts/ros2/compiling-for-amd64-based-systems.md
diff --git a/docs/ros2/compiling-for-arm-based-systems.md b/docs/ros2/compiling-for-arm-based-systems.md
@@ -1 +1 @@
-../../ros2/compiling-for-arm-based-systems.md
+../../scripts/ros2/compiling-for-arm-based-systems.md
diff --git a/docs/ros2/general-instructions.md b/docs/ros2/general-instructions.md
@@ -1 +1 @@
-../../ros2/general-instructions.md
+../../scripts/ros2/general-instructions.md
diff --git a/docs/ros2/installing-precompiled-packages.md b/docs/ros2/installing-precompiled-packages.md
@@ -1 +1 @@
-../../ros2/installing-precompiled-packages.md
+../../scripts/ros2/installing-precompiled-packages.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,7 +8,7 @@ repo_url: https://github.com/ResidenciaTICBrisa/03_Robotica
 
 copyright: Copyright &copy; 2023 BRISA
 
-theme: 
+theme:
   name: material
   features:
     - navigation.tabs
@@ -48,7 +48,7 @@ theme:
 
 plugins:
   - search:
-      lang: 
+      lang:
         - pt
         - en
       separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
@@ -68,11 +68,16 @@ nav:
   - Home: index.md
   - Instruções:
     - Maquina Virtual: Instruções/Maquina_Virtual.md
-    - ROS1: Instruções/ROS1.md
+    - ROS1:
+      - Instruções: Instruções/ROS1.md
+      - General: ros1/general-instructions.md
+      - Precompiled: ros1/installing-precompiled-packages.md
+      - Compiling: ros1/compiling-for-amd64-based-systems.md
+      - Compiling for SBCs: ros1/compiling-for-arm-based-systems.md
     - ROS2:
       - General: ros2/general-instructions.md
       - Precompiled: ros2/installing-precompiled-packages.md
       - Compiling: ros2/compiling-for-amd64-based-systems.md
       - Compiling for SBCs: ros2/compiling-for-arm-based-systems.md
     - Robot Settings: Instruções/Robot_Settings.md
-    - SDK C++: Instruções/CPP_SDK.md
+    - SDK C++: Instruções/CPP_SDK.md
diff --git a/ros1/.gitignore → scripts/ros1/.gitignore b/ros1/.gitignore → scripts/ros1/.gitignore
diff --git a/ros1/bootstrap-chroot-32.sh → scripts/ros1/bootstrap-chroot-32.sh b/ros1/bootstrap-chroot-32.sh → scripts/ros1/bootstrap-chroot-32.sh
diff --git a/ros1/bootstrap-chroot-64.sh → scripts/ros1/bootstrap-chroot-64.sh b/ros1/bootstrap-chroot-64.sh → scripts/ros1/bootstrap-chroot-64.sh
diff --git a/ros1/chroot-env-vars.sh → scripts/ros1/chroot-env-vars.sh b/ros1/chroot-env-vars.sh → scripts/ros1/chroot-env-vars.sh
diff --git a/ros1/compiling-for-amd64-based-systems.md → ...ros1/compiling-for-amd64-based-systems.md b/ros1/compiling-for-amd64-based-systems.md → ...ros1/compiling-for-amd64-based-systems.md
diff --git a/ros1/compiling-for-arm-based-systems.md → ...s/ros1/compiling-for-arm-based-systems.md b/ros1/compiling-for-arm-based-systems.md → ...s/ros1/compiling-for-arm-based-systems.md
diff --git a/ros1/general-instructions.md → scripts/ros1/general-instructions.md b/ros1/general-instructions.md → scripts/ros1/general-instructions.md
diff --git a/ros1/installing-native-packages.md → scripts/ros1/installing-native-packages.md b/ros1/installing-native-packages.md → scripts/ros1/installing-native-packages.md
diff --git a/ros1/installing-precompiled-packages.md → ...s/ros1/installing-precompiled-packages.md b/ros1/installing-precompiled-packages.md → ...s/ros1/installing-precompiled-packages.md
diff --git a/ros1/ubuntu-compile-install-ros1-32.sh → ...ts/ros1/ubuntu-compile-install-ros1-32.sh b/ros1/ubuntu-compile-install-ros1-32.sh → ...ts/ros1/ubuntu-compile-install-ros1-32.sh
diff --git a/ros1/ubuntu-compile-install-ros1-64.sh → ...ts/ros1/ubuntu-compile-install-ros1-64.sh b/ros1/ubuntu-compile-install-ros1-64.sh → ...ts/ros1/ubuntu-compile-install-ros1-64.sh
diff --git a/ros1/ubuntu-compile-install-ros1-noetic.sh → ...os1/ubuntu-compile-install-ros1-noetic.sh b/ros1/ubuntu-compile-install-ros1-noetic.sh → ...os1/ubuntu-compile-install-ros1-noetic.sh
diff --git a/ros1/ubuntu-install-ros1-32-base.sh → scripts/ros1/ubuntu-install-ros1-32-base.sh b/ros1/ubuntu-install-ros1-32-base.sh → scripts/ros1/ubuntu-install-ros1-32-base.sh
diff --git a/ros1/ubuntu-install-ros1-32-desktop.sh → ...ts/ros1/ubuntu-install-ros1-32-desktop.sh b/ros1/ubuntu-install-ros1-32-desktop.sh → ...ts/ros1/ubuntu-install-ros1-32-desktop.sh
diff --git a/ros1/ubuntu-install-ros1-64-base.sh → scripts/ros1/ubuntu-install-ros1-64-base.sh b/ros1/ubuntu-install-ros1-64-base.sh → scripts/ros1/ubuntu-install-ros1-64-base.sh
diff --git a/ros1/ubuntu-install-ros1-64-desktop-full.sh → ...s1/ubuntu-install-ros1-64-desktop-full.sh b/ros1/ubuntu-install-ros1-64-desktop-full.sh → ...s1/ubuntu-install-ros1-64-desktop-full.sh
diff --git a/ros1/ubuntu-install-ros1-64-desktop.sh → ...ts/ros1/ubuntu-install-ros1-64-desktop.sh b/ros1/ubuntu-install-ros1-64-desktop.sh → ...ts/ros1/ubuntu-install-ros1-64-desktop.sh
diff --git a/ros1/ubuntu-install-ros1-noetic-base.sh → ...s/ros1/ubuntu-install-ros1-noetic-base.sh b/ros1/ubuntu-install-ros1-noetic-base.sh → ...s/ros1/ubuntu-install-ros1-noetic-base.sh
diff --git a/...buntu-install-ros1-noetic-desktop-full.sh → ...buntu-install-ros1-noetic-desktop-full.sh b/...buntu-install-ros1-noetic-desktop-full.sh → ...buntu-install-ros1-noetic-desktop-full.sh
diff --git a/ros1/ubuntu-install-ros1-noetic-desktop.sh → ...os1/ubuntu-install-ros1-noetic-desktop.sh b/ros1/ubuntu-install-ros1-noetic-desktop.sh → ...os1/ubuntu-install-ros1-noetic-desktop.sh
diff --git a/ros2/.gitignore → scripts/ros2/.gitignore b/ros2/.gitignore → scripts/ros2/.gitignore
diff --git a/ros2/bootstrap-chroot-32.sh → scripts/ros2/bootstrap-chroot-32.sh b/ros2/bootstrap-chroot-32.sh → scripts/ros2/bootstrap-chroot-32.sh
diff --git a/ros2/bootstrap-chroot-64.sh → scripts/ros2/bootstrap-chroot-64.sh b/ros2/bootstrap-chroot-64.sh → scripts/ros2/bootstrap-chroot-64.sh
diff --git a/ros2/chroot-env-vars.sh → scripts/ros2/chroot-env-vars.sh b/ros2/chroot-env-vars.sh → scripts/ros2/chroot-env-vars.sh
diff --git a/ros2/compiling-for-amd64-based-systems.md → ...ros2/compiling-for-amd64-based-systems.md b/ros2/compiling-for-amd64-based-systems.md → ...ros2/compiling-for-amd64-based-systems.md
diff --git a/ros2/compiling-for-arm-based-systems.md → ...s/ros2/compiling-for-arm-based-systems.md b/ros2/compiling-for-arm-based-systems.md → ...s/ros2/compiling-for-arm-based-systems.md
diff --git a/ros2/general-instructions.md → scripts/ros2/general-instructions.md b/ros2/general-instructions.md → scripts/ros2/general-instructions.md
diff --git a/ros2/installing-precompiled-packages.md → ...s/ros2/installing-precompiled-packages.md b/ros2/installing-precompiled-packages.md → ...s/ros2/installing-precompiled-packages.md
diff --git a/ros2/ubuntu-compile-install-ros2-32.sh → ...ts/ros2/ubuntu-compile-install-ros2-32.sh b/ros2/ubuntu-compile-install-ros2-32.sh → ...ts/ros2/ubuntu-compile-install-ros2-32.sh
diff --git a/ros2/ubuntu-compile-install-ros2-64.sh → ...ts/ros2/ubuntu-compile-install-ros2-64.sh b/ros2/ubuntu-compile-install-ros2-64.sh → ...ts/ros2/ubuntu-compile-install-ros2-64.sh
diff --git a/ros2/ubuntu-compile-install-ros2-humble.sh → ...os2/ubuntu-compile-install-ros2-humble.sh b/ros2/ubuntu-compile-install-ros2-humble.sh → ...os2/ubuntu-compile-install-ros2-humble.sh
diff --git a/ros2/ubuntu-install-ros2-64-base.sh → scripts/ros2/ubuntu-install-ros2-64-base.sh b/ros2/ubuntu-install-ros2-64-base.sh → scripts/ros2/ubuntu-install-ros2-64-base.sh
diff --git a/ros2/ubuntu-install-ros2-64-desktop.sh → ...ts/ros2/ubuntu-install-ros2-64-desktop.sh b/ros2/ubuntu-install-ros2-64-desktop.sh → ...ts/ros2/ubuntu-install-ros2-64-desktop.sh
diff --git a/ros2/ubuntu-install-ros2-humble-base.sh → ...s/ros2/ubuntu-install-ros2-humble-base.sh b/ros2/ubuntu-install-ros2-humble-base.sh → ...s/ros2/ubuntu-install-ros2-humble-base.sh
diff --git a/ros2/ubuntu-install-ros2-humble-desktop.sh → ...os2/ubuntu-install-ros2-humble-desktop.sh b/ros2/ubuntu-install-ros2-humble-desktop.sh → ...os2/ubuntu-install-ros2-humble-desktop.sh