From fbccff00aba12a1c27a7e28c73bb20d2428ed745 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9rgio=20Souza=20Costa?= Date: Thu, 12 Mar 2026 16:50:19 -0300 Subject: [PATCH 1/7] Atualizar o mkdocs.yml --- mkdocs.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 2c90885..34f82ae 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 # atual + - Raster: api/geo/raster.md # novo - Visualization: api/visualization.md From d840af6bd144f2aef3b9630f8226d7c7db316d60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9rgio=20Souza=20Costa?= Date: Thu, 12 Mar 2026 16:53:25 -0300 Subject: [PATCH 2/7] Add documentation for Geo vector classes and utilities --- docs/api/geo/vector.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 docs/api/geo/vector.md 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 From 511dd3bc1cd1b7339521c9f1d13a7f1ffd8759f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9rgio=20Souza=20Costa?= Date: Thu, 12 Mar 2026 16:55:11 -0300 Subject: [PATCH 3/7] Create raster.md for Geo raster documentation Add documentation for raster substrate classes and utilities. --- docs/api/geo/raster.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 docs/api/geo/raster.md 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 From ab15525b6092f85fdf692b426905db4b546d1852 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9rgio=20Souza=20Costa?= Date: Thu, 12 Mar 2026 17:05:37 -0300 Subject: [PATCH 4/7] Create docs_deploy.md --- .github/workflows/docs_deploy.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/workflows/docs_deploy.md diff --git a/.github/workflows/docs_deploy.md b/.github/workflows/docs_deploy.md new file mode 100644 index 0000000..112692a --- /dev/null +++ b/.github/workflows/docs_deploy.md @@ -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 }} From 2d164da9f1542cf0deb3a9fbfed30a0b5d8e3499 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9rgio=20Souza=20Costa?= Date: Thu, 12 Mar 2026 17:10:33 -0300 Subject: [PATCH 5/7] Rename docs_deploy.md to docs_deploy.yml --- .github/workflows/{docs_deploy.md => docs_deploy.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{docs_deploy.md => docs_deploy.yml} (100%) diff --git a/.github/workflows/docs_deploy.md b/.github/workflows/docs_deploy.yml similarity index 100% rename from .github/workflows/docs_deploy.md rename to .github/workflows/docs_deploy.yml From b4cb8fad908cc77e1e9525464f96917c1c8a0ca2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9rgio=20Souza=20Costa?= Date: Thu, 12 Mar 2026 18:02:09 -0300 Subject: [PATCH 6/7] Atualizar o mkdocs.yml --- mkdocs.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 34f82ae..2a38056 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -58,8 +58,8 @@ nav: - API Reference: - Core: api/core.md - - Geo - - Vector: api/geo/vector.md # atual - - Raster: api/geo/raster.md # novo + - Geo: + - Vector: api/geo/vector.md + - Raster: api/geo/raster.md - Visualization: api/visualization.md From 22ea8ebed3dd7756de3bd06ca28f03c15479095d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9rgio=20Souza=20Costa?= Date: Thu, 12 Mar 2026 18:04:53 -0300 Subject: [PATCH 7/7] Delete docs/api/geo.md --- docs/api/geo.md | 6 ------ 1 file changed, 6 deletions(-) delete mode 100644 docs/api/geo.md 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