From 48c1b6911c1287d064fd0f389eb588066411a5cd Mon Sep 17 00:00:00 2001
From: "Benjamin A. Beasley" <code@musicinmybrain.net>
Date: Sun, 12 Dec 2021 13:03:22 -0500
Subject: [PATCH] [docs] global: refactore user manual generation
---
generateDocumentation.sh | 57 +++++++++++++++-------------------------
1 file changed, 21 insertions(+), 36 deletions(-)
diff --git a/generateDocumentation.sh b/generateDocumentation.sh
index 5753f9f..5e1ae19 100755
--- a/generateDocumentation.sh
+++ b/generateDocumentation.sh
@@ -41,42 +41,27 @@ fi
if [[ "${USER}" != 0 ]]
then
cd docs/user
- sed -n "3p" intro.md > User_Manual.md
- tail -n +7 intro.md >> User_Manual.md
- echo -e "\n" >> User_Manual.md
- sed -n "3p" installation.md >> User_Manual.md
- tail -n +7 installation.md >> User_Manual.md
- echo -e "\n" >> User_Manual.md
- sed -n "3p" example.md >> User_Manual.md
- tail -n +7 example.md >> User_Manual.md
- echo -e "\n" >> User_Manual.md
- sed -n "3p" dataPreparation.md >> User_Manual.md
- tail -n +7 dataPreparation.md >> User_Manual.md
- echo -e "\n" >> User_Manual.md
- sed -n "3p" timeline.md >> User_Manual.md
- tail -n +7 timeline.md >> User_Manual.md
- echo -e "\n" >> User_Manual.md
- sed -n "3p" interactiveTracking.md >> User_Manual.md
- tail -n +7 interactiveTracking.md >> User_Manual.md
- echo -e "\n" >> User_Manual.md
- sed -n "3p" batchTracking.md >> User_Manual.md
- tail -n +7 batchTracking.md >> User_Manual.md
- echo -e "\n" >> User_Manual.md
- sed -n "3p" trackingInspector.md >> User_Manual.md
- tail -n +7 trackingInspector.md >> User_Manual.md
- echo -e "\n" >> User_Manual.md
- sed -n "3p" trackingCli.md >> User_Manual.md
- tail -n +7 trackingCli.md >> User_Manual.md
- echo -e "\n" >> User_Manual.md
- sed -n "3p" trackingParameters.md >> User_Manual.md
- tail -n +7 trackingParameters.md >> User_Manual.md
- echo -e "\n" >> User_Manual.md
- sed -n "3p" parametersSelection.md >> User_Manual.md
- tail -n +7 parametersSelection.md >> User_Manual.md
- echo -e "\n" >> User_Manual.md
- sed -n "3p" dataOutput.md >> User_Manual.md
- tail -n +7 dataOutput.md >> User_Manual.md
- sed -i "s/title:/#/g" User_Manual.md
+ {
+ for part in \
+ intro \
+ installation \
+ example \
+ dataPreparation \
+ timeline \
+ interactiveTracking \
+ batchTracking \
+ trackingInspector \
+ trackingCli \
+ trackingParameters \
+ parametersSelection \
+ dataOutput
+ do
+ sed -n '3p' "${part}.md"
+ tail -n '+7' "${part}.md"
+ echo -e '\n'
+ done
+ } | sed 's/title:/#/g' > User_Manual.md
+
mkdir -p ../../manual/user/html
pandoc User_Manual.md -f markdown --mathjax --toc -t html5 -c css/style.css -s -o user_manual.html
cp -r css ../../manual/user/html