python docs ci fix (#376)

geoarrow · Jan 2, 2024 · 383a16f · 383a16f
1 parent 2fba3fb
commit 383a16f
Show file tree

Hide file tree

Showing 14 changed files with 242 additions and 200 deletions.
diff --git a/.github/workflows/python-docs.yml b/.github/workflows/python-docs.yml
@@ -20,6 +20,11 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - uses: Swatinem/rust-cache@v2
+
       - name: Set up Python 3.11
         id: setup-python
         uses: actions/setup-python@v4
@@ -45,6 +50,10 @@ jobs:
         if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
         run: poetry install --no-interaction --no-root
 
+      - name: Build python package
+        run: |
+          poetry run maturin build
+
       - name: Install root project
         run: poetry install --no-interaction
 
@@ -63,6 +72,6 @@ jobs:
 
           # Only push docs if no letters in git tag after the first character
           # (usually the git tag will have v as the first character)
-          if ! echo $VERSION | cut -c 1- | grep -q "[A-Za-z]"; then
+          if echo $VERSION | cut -c 1- | grep -q "[A-Za-z]"; then
             poetry run mike deploy $VERSION latest --update-aliases --push
           fi
diff --git a/python/core/README.md b/python/core/README.md
@@ -1,4 +1,6 @@
-# `geoarrow.rust.core`: Python bindings to `geoarrow-rs`
+# `geoarrow.rust.core`
+
+Python bindings to `geoarrow-rs`
 
 ## Overview
 

diff --git a/python/core/docs/api/functions.md b/python/core/docs/api/functions.md
@@ -9,4 +9,15 @@
         - signed_area
         - center
         - centroid
+        - chaikin_smoothing
+        - chamberlain_duquette_unsigned_area
+        - chamberlain_duquette_signed_area
         - convex_hull
+        - densify
+        - envelope
+        - is_empty
+        - geodesic_area_signed
+        - geodesic_area_unsigned
+        - geodesic_perimeter
+        - simplify
+        - simplify_vw
diff --git a/python/core/docs/api/index.md b/python/core/docs/api/index.md
diff --git a/python/core/docs/api/primitive/array.md b/python/core/docs/api/primitive/array.md
@@ -4,10 +4,10 @@ Arrays of non-geospatial types. These exist to be used as _return_ types from
 geospatial operations to maintain strong typing.
 
 - [`BooleanArray`](#geoarrow.rust.core.BooleanArray)
-- [`Float16Array`](#geoarrow.rust.core.Float16Array)
-- [`Float32Array`](#geoarrow.rust.core.Float32Array)
+<!-- - [`Float16Array`](#geoarrow.rust.core.Float16Array)
+- [`Float32Array`](#geoarrow.rust.core.Float32Array) -->
 - [`Float64Array`](#geoarrow.rust.core.Float64Array)
-- [`UInt8Array`](#geoarrow.rust.core.UInt8Array)
+<!-- - [`UInt8Array`](#geoarrow.rust.core.UInt8Array)
 - [`UInt16Array`](#geoarrow.rust.core.UInt16Array)
 - [`UInt32Array`](#geoarrow.rust.core.UInt32Array)
 - [`UInt64Array`](#geoarrow.rust.core.UInt64Array)
@@ -16,7 +16,7 @@ geospatial operations to maintain strong typing.
 - [`Int32Array`](#geoarrow.rust.core.Int32Array)
 - [`Int64Array`](#geoarrow.rust.core.Int64Array)
 - [`StringArray`](#geoarrow.rust.core.StringArray)
-- [`LargeStringArray`](#geoarrow.rust.core.LargeStringArray)
+- [`LargeStringArray`](#geoarrow.rust.core.LargeStringArray) -->
 
 ::: geoarrow.rust.core
     options:
@@ -25,16 +25,4 @@ geospatial operations to maintain strong typing.
         - "^__arrow"
       members:
         - BooleanArray
-        - Float16Array
-        - Float32Array
         - Float64Array
-        - UInt8Array
-        - UInt16Array
-        - UInt32Array
-        - UInt64Array
-        - Int8Array
-        - Int16Array
-        - Int32Array
-        - Int64Array
-        - StringArray
-        - LargeStringArray
diff --git a/python/core/docs/api/primitive/chunked.md b/python/core/docs/api/primitive/chunked.md
@@ -4,10 +4,10 @@ Chunked arrays of non-geospatial types. These exist to be used as _return_ types
 from geospatial operations to maintain strong typing.
 
 - [`ChunkedBooleanArray`](#geoarrow.rust.core.ChunkedBooleanArray)
-- [`ChunkedFloat16Array`](#geoarrow.rust.core.ChunkedFloat16Array)
-- [`ChunkedFloat32Array`](#geoarrow.rust.core.ChunkedFloat32Array)
+<!-- - [`ChunkedFloat16Array`](#geoarrow.rust.core.ChunkedFloat16Array)
+- [`ChunkedFloat32Array`](#geoarrow.rust.core.ChunkedFloat32Array) -->
 - [`ChunkedFloat64Array`](#geoarrow.rust.core.ChunkedFloat64Array)
-- [`ChunkedUInt8Array`](#geoarrow.rust.core.ChunkedUInt8Array)
+<!-- - [`ChunkedUInt8Array`](#geoarrow.rust.core.ChunkedUInt8Array)
 - [`ChunkedUInt16Array`](#geoarrow.rust.core.ChunkedUInt16Array)
 - [`ChunkedUInt32Array`](#geoarrow.rust.core.ChunkedUInt32Array)
 - [`ChunkedUInt64Array`](#geoarrow.rust.core.ChunkedUInt64Array)
@@ -16,7 +16,7 @@ from geospatial operations to maintain strong typing.
 - [`ChunkedInt32Array`](#geoarrow.rust.core.ChunkedInt32Array)
 - [`ChunkedInt64Array`](#geoarrow.rust.core.ChunkedInt64Array)
 - [`ChunkedStringArray`](#geoarrow.rust.core.ChunkedStringArray)
-- [`ChunkedLargeStringArray`](#geoarrow.rust.core.ChunkedLargeStringArray)
+- [`ChunkedLargeStringArray`](#geoarrow.rust.core.ChunkedLargeStringArray) -->
 
 ::: geoarrow.rust.core
     options:
@@ -25,16 +25,4 @@ from geospatial operations to maintain strong typing.
         - "^__arrow"
       members:
         - ChunkedBooleanArray
-        - ChunkedFloat16Array
-        - ChunkedFloat32Array
         - ChunkedFloat64Array
-        - ChunkedUInt8Array
-        - ChunkedUInt16Array
-        - ChunkedUInt32Array
-        - ChunkedUInt64Array
-        - ChunkedInt8Array
-        - ChunkedInt16Array
-        - ChunkedInt32Array
-        - ChunkedInt64Array
-        - ChunkedStringArray
-        - ChunkedLargeStringArray
diff --git a/python/core/docs/api/table.md b/python/core/docs/api/table.md
@@ -1,6 +1,6 @@
 # GeoTable
 
-::: geoarrow.rust.core.rust
+::: geoarrow.rust.core
     options:
       filters:
         - "!^_"

diff --git a/python/core/docs/api/types.md b/python/core/docs/api/types.md
@@ -0,0 +1,3 @@
+# Types
+
+::: geoarrow.rust.core.types
diff --git a/python/core/mkdocs.yml b/python/core/mkdocs.yml
@@ -22,7 +22,6 @@ extra:
 nav:
   - "index.md"
   - API Reference:
-      - api/index.md
       - Geometry Arrays:
         - api/geometry/array.md
         - api/geometry/chunked.md
@@ -32,12 +31,13 @@ nav:
       - api/table.md
       - Operations: api/functions.md
       - IO: api/io.md
+      - Types: api/types.md
 
   # - Caveats: caveats.md
-  - Performance: performance.md
-  - Changelog: CHANGELOG.md
-  - Alternatives: alternatives.md
-  - "How it works?": how-it-works.md
+  # - Performance: performance.md
+  # - Changelog: CHANGELOG.md
+  # - Alternatives: alternatives.md
+  # - "How it works?": how-it-works.md
 
 watch:
   - python

diff --git a/python/core/poetry.lock b/python/core/poetry.lock
diff --git a/python/core/pyproject.toml b/python/core/pyproject.toml
@@ -34,3 +34,7 @@ mkdocstrings = {version = "^0.23.0", extras = ["python"]}
 mkdocs-jupyter = {version = "^0.24.5", python = "^3.9"}
 mike = "^2"
 
+
+[tool.poetry.group.dev.dependencies]
+maturin = "^1.4.0"
+