Merge pull request #27 from saudzahirr/docs

Add docs serve, build & deploy scripts
saudzahirr · Sep 1, 2024 · a65cec5 · a65cec5
2 parents 5fc5de3 + 8415f1f
commit a65cec5
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 0 deletions.
diff --git a/environment.yml b/environment.yml
@@ -17,3 +17,6 @@ dependencies:
   - ruff
   - pytest
   - tqdm
+  - pip
+  - pip:
+    - mkdocs-material
diff --git a/scripts/deploy b/scripts/deploy
@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -e
+cd ../docs
+source $(conda info --base)/etc/profile.d/conda.sh
+conda activate vm
+mkdocs build
+sleep 4
+mkdocs gh-deploy --clean
+git clean -xfd
+sleep 4
+open https://saudzahirr.github.io/vonMises/
diff --git a/scripts/deploy.bat b/scripts/deploy.bat
@@ -0,0 +1,12 @@
+@echo off
+setlocal enabledelayedexpansion
+
+cd ..\docs
+call conda activate vm
+mkdocs build
+timeout /t 4 /nobreak >nul
+mkdocs gh-deploy --clean
+timeout /t 4 /nobreak >nul
+start https://saudzahirr.github.io/vonMises/
+
+endlocal
diff --git a/scripts/serve b/scripts/serve
@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -e
+cd ../docs
+source $(conda info --base)/etc/profile.d/conda.sh
+conda activate vm
+mkdocs serve &
+sleep 4
+open http://127.0.0.1:8000/vonMises/
diff --git a/scripts/serve.bat b/scripts/serve.bat
@@ -0,0 +1,6 @@
+@echo off
+cd ..\docs
+call conda activate vm
+start mkdocs serve
+timeout /t 5 /nobreak >nul
+start http://127.0.0.1:8000/vonMises/