test

Author: amrabed

.github/workflows/github-pages.yml

@@ -0,0 +1,33 @@
+name: Publish documentation to GitHub Pages
+on:
+  workflow_call:
+  push:
+    # branches:
+    #   - main
+    paths:
+        - "docs/**"
+        - mkdocs.yml
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email github-actions[bot]@github.com
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force

mkdocs.yml

@@ -23,6 +23,7 @@ theme:
   - toc.follow
 
 
+
 nav:
   - Overview: README.md
   - Reference: