diff --git a/.github/workflows/docs_deploy.yml b/.github/workflows/docs_deploy.yml new file mode 100644 index 0000000..112692a --- /dev/null +++ b/.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 }} diff --git a/docs/api/geo.md b/docs/api/geo.md deleted file mode 100644 index e8d05ed..0000000 --- a/docs/api/geo.md +++ /dev/null @@ -1,6 +0,0 @@ -# Geo - -::: dissmodel.geo.CellularAutomaton -::: dissmodel.geo.regular_grid -::: dissmodel.geo.fill -::: dissmodel.geo.neighborhood.attach_neighbors diff --git a/docs/api/geo/raster.md b/docs/api/geo/raster.md new file mode 100644 index 0000000..b66b984 --- /dev/null +++ b/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 diff --git a/docs/api/geo/vector.md b/docs/api/geo/vector.md new file mode 100644 index 0000000..172b6c9 --- /dev/null +++ b/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 diff --git a/mkdocs.yml b/mkdocs.yml index 2c90885..2a38056 100644 --- a/mkdocs.yml +++ b/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