ci: enable mkdocs github action

Signed-off-by: Huaqi Fang <[email protected]>

.github/prepare_doc.sh

@@ -0,0 +1,17 @@
+#!/bin/env bash
+
+if [ ! -f mkdocs.yml ] ; then
+    echo "Not in mkdocs.yml located document folder!"
+    exit 1
+fi
+
+# update mkdocs.yml and README.md
+python3 update.py
+rm -rf docs site
+mkdir -p docs
+cp -rf *.md docs/
+cp -rf asserts/ docs/
+
+echo "Document for mkdocs is prepared!"
+echo "Run the following command to build and serve these doc!"
+echo "mkdocs serve -a 0.0.0.0:8009"

.github/mkdoc.yml → .github/workflows/mkdoc.yml

@@ -27,12 +27,7 @@ jobs:
 
       - name: Prepare docs
         run: |
-          python3 update.py
-          mkdir docs
-          cp *.md docs/
-          cp -rf asserts/ docs/
-          # update mkdocs.yml
-          python3 update.py
+            bash .github/prepare_doc.sh
 
       - name: Build MkDocs
         run: mkdocs build

README.md

@@ -6,7 +6,7 @@ Please create new doc based on [Doc Template](0-template.md)
 
 ## Documents
 
-> Generated by `python3 update.py` @ 2023-12-01 16:41:30
+> Generated by `python3 update.py` @ 2023-12-01 17:06:53
 
 | Document | Description |
 |:---|:---|