Merge pull request #12 from sdsc-ordes/chore/mkdocs

.github/workflows/mkdocs-ci.yml

@@ -0,0 +1,31 @@
+name: mkdocs-ci 
+on:
+  push:
+    branches:
+      - master 
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - 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: pip install "mkdocstrings[python]"
+      - run: pip install mkdocs-homepage-copier
+      - run: mkdocs gh-deploy --force

docs/app.md

@@ -0,0 +1,5 @@
+Here is the documentation for the app code generating the streamlit front-end. 
+
+# Streamlit App 
+
+::: basic_map.app

mkdocs.yaml

@@ -0,0 +1,24 @@
+site_name: Saving Willy Code Documentation
+dev_addr: 127.0.0.1:8888
+theme:
+  name: material
+
+markdown_extensions:
+  - pymdownx.snippets:
+      check_paths: true
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+
+plugins:
+  - mkdocs-homepage-copier
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          paths: [src]
+
+
+nav:
+  - README: index.md

requirements.txt

@@ -26,3 +26,9 @@ pillow==10.4.0
 ## also need opencv for handling images in the later model with preprocessing
 opencv-python-headless==4.5.5.64
 albumentations==1.1.0
+
+# documentation: mkdocs
+mkdocs~=1.6.0
+mkdocstrings[python]>=0.25.1
+mkdocs-material~=9.5.27
+mkdocs-homepage-copier~=1.0.0