Sync

.github/workflows/docs_deploy.yml

@@ -0,0 +1,23 @@
+name: Deploy documentation to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+
+      - name: Deploy to GitHub Pages
+        run: mkdocs gh-deploy --force
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/api/geo/raster.md

@@ -0,0 +1,33 @@
+# Geo — Raster
+
+Raster substrate classes and utilities backed by NumPy arrays.
+
+::: dissmodel.geo.raster.backend
+    options:
+      show_source: true
+      show_root_heading: true
+      members:
+        - RasterBackend
+        - DIRS_MOORE
+        - DIRS_VON_NEUMANN
+
+::: dissmodel.geo.raster.model
+    options:
+      show_source: true
+      show_root_heading: true
+      members:
+        - RasterModel
+
+::: dissmodel.geo.raster.cellular_automaton
+    options:
+      show_source: true
+      show_root_heading: true
+      members:
+        - RasterCellularAutomaton
+
+::: dissmodel.geo.raster.regular_grid
+    options:
+      show_source: true
+      show_root_heading: true
+      members:
+        - make_raster_grid

docs/api/geo/vector.md

@@ -0,0 +1,41 @@
+# Geo — Vector
+
+Vector substrate classes and utilities backed by GeoDataFrame.
+
+::: dissmodel.geo.vector.model
+    options:
+      show_source: true
+      show_root_heading: true
+      members:
+        - SpatialModel
+
+::: dissmodel.geo.vector.cellular_automaton
+    options:
+      show_source: true
+      show_root_heading: true
+      members:
+        - CellularAutomaton
+
+::: dissmodel.geo.vector.regular_grid
+    options:
+      show_source: true
+      show_root_heading: true
+      members:
+        - regular_grid
+        - parse_idx
+
+::: dissmodel.geo.vector.fill
+    options:
+      show_source: true
+      show_root_heading: true
+      members:
+        - FillStrategy
+        - fill
+        - register_strategy
+
+::: dissmodel.geo.vector.neighborhood
+    options:
+      show_source: true
+      show_root_heading: true
+      members:
+        - attach_neighbors

mkdocs.yml

@@ -58,6 +58,8 @@ nav:
 
   - API Reference:
     - Core: api/core.md
-    - Geo: api/geo.md
+    - Geo:
+      - Vector: api/geo/vector.md
+      - Raster:  api/geo/raster.md
     - Visualization: api/visualization.md