Skip to content

Commit aa6e498

Browse files
author
Murilo Marinho
committed
Renaming subproject readmes to make sure link is meaningful.
1 parent 70efa37 commit aa6e498

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

docs/myst.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ project:
2626
- file: installation.md
2727
- title: "Modules"
2828
children:
29-
- file: submodules/docker-coppeliasim/README.md
30-
- file: submodules/sas_ur_control_template/README.md
31-
- file: submodules/sas_kuka_control_template/README.md
29+
- file: submodules/docker-coppeliasim/docker-coppeliasim_README.md
30+
- file: submodules/sas_ur_control_template/sas_ur_control_template_README.md
31+
- file: submodules/sas_kuka_control_template/sas_kuka_control_template_README.md
3232
- file: CHANGELOG.md
3333

3434
site:

docs/scripts/pre_build.sh

100644100755
Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
#!/bin/bash
22
set -e
33

4+
clone_and_rename_readme(){
5+
# $1 must be the repository name
6+
# $2 must be the branch
7+
8+
FOLDER_NAME=$(basename "$1" .git)
9+
10+
git clone "$1" -b "$2" --single-branch --depth=1
11+
cd "$FOLDER_NAME"
12+
mv README.md "${FOLDER_NAME}"_README.md
13+
cd ..
14+
}
15+
416
# Submodules
517
cd .. # This script is meant to be called in its own directory
618
mkdir -p submodules
719
cd submodules
820

9-
git clone https://github.com/SmartArmStack/docker-coppeliasim.git --single-branch --depth=1
10-
git clone https://github.com/MarinhoLab/sas_ur_control_template.git --single-branch --depth=1
11-
git clone https://github.com/MarinhoLab/sas_kuka_control_template.git --single-branch --depth=1
21+
clone_and_rename_readme https://github.com/SmartArmStack/docker-coppeliasim.git main
22+
clone_and_rename_readme https://github.com/MarinhoLab/sas_ur_control_template.git main
23+
clone_and_rename_readme https://github.com/MarinhoLab/sas_kuka_control_template.git main

0 commit comments

Comments
 (0)