summaryrefslogtreecommitdiffstats
path: root/docs/serve.sh
diff options
context:
space:
mode:
authorClementTsang <34804052+ClementTsang@users.noreply.github.com>2023-02-04 04:58:12 -0500
committerClementTsang <34804052+ClementTsang@users.noreply.github.com>2023-02-04 04:58:16 -0500
commit9ed5df15bba14d264684cde38e21ddc0856a5260 (patch)
treedceedfa1468adae88a9c0a2c8edc7ee252464aa8 /docs/serve.sh
parentbce95c0d4859c6e2b0e5763d4027a18cad51f34a (diff)
docs: add script to serve mkdocs locally
Diffstat (limited to 'docs/serve.sh')
-rwxr-xr-xdocs/serve.sh20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/serve.sh b/docs/serve.sh
new file mode 100755
index 00000000..ad833056
--- /dev/null
+++ b/docs/serve.sh
@@ -0,0 +1,20 @@
+#!/bin/bash
+
+set -e
+
+VENV_PATH="./venv/"
+PYTHON_CMD=${1:-python}
+
+if [ ! -d $VENV_PATH ]; then
+ echo "venv not found, creating one using the command '${PYTHON_CMD}'...";
+ $PYTHON_CMD -m venv venv;
+ source ./venv/bin/activate;
+ pip install --upgrade pip;
+ pip install -r requirements.txt;
+ ./venv/bin/mkdocs serve;
+else
+ echo "venv already found.";
+ source ./venv/bin/activate;
+ ./venv/bin/mkdocs serve;
+fi;
+