python: improved docs (#373)

geoarrow · Jan 2, 2024 · 2fba3fb · 2fba3fb
1 parent 279ad64
commit 2fba3fb
Show file tree

Hide file tree

Showing 37 changed files with 962 additions and 200 deletions.
diff --git a/python/core/Cargo.lock b/python/core/Cargo.lock
diff --git a/python/core/docs/api/geometry/array.md b/python/core/docs/api/geometry/array.md
@@ -10,6 +10,7 @@ The classes on this page represent arrays of geospatial geometries.
 - [`MultiPolygonArray`](#geoarrow.rust.core.MultiPolygonArray)
 - [`MixedGeometryArray`](#geoarrow.rust.core.MixedGeometryArray)
 - [`GeometryCollectionArray`](#geoarrow.rust.core.GeometryCollectionArray)
+- [`WKBArray`](#geoarrow.rust.core.WKBArray)
 - [`RectArray`](#geoarrow.rust.core.RectArray)
 
 ::: geoarrow.rust.core
@@ -26,4 +27,5 @@ The classes on this page represent arrays of geospatial geometries.
         - MultiPolygonArray
         - MixedGeometryArray
         - GeometryCollectionArray
+        - WKBArray
         - RectArray
diff --git a/python/core/docs/api/geometry/chunked.md b/python/core/docs/api/geometry/chunked.md
@@ -10,6 +10,7 @@ Chunked arrays of geospatial geometries, each of the same type.
 - [`ChunkedMultiPolygonArray`](#geoarrow.rust.core.ChunkedMultiPolygonArray)
 - [`ChunkedMixedGeometryArray`](#geoarrow.rust.core.ChunkedMixedGeometryArray)
 - [`ChunkedGeometryCollectionArray`](#geoarrow.rust.core.ChunkedGeometryCollectionArray)
+- [`ChunkedWKBArray`](#geoarrow.rust.core.ChunkedWKBArray)
 - [`ChunkedRectArray`](#geoarrow.rust.core.ChunkedRectArray)
 
 ::: geoarrow.rust.core
@@ -26,4 +27,5 @@ Chunked arrays of geospatial geometries, each of the same type.
         - ChunkedMultiPolygonArray
         - ChunkedMixedGeometryArray
         - ChunkedGeometryCollectionArray
+        - ChunkedWKBArray
         - ChunkedRectArray
diff --git a/python/core/docs/api/io.md b/python/core/docs/api/io.md
@@ -5,5 +5,10 @@
       filters:
         - "!^_"
       members:
+        - from_ewkb
         - from_wkb
+        - from_wkt
         - to_wkb
+        - read_csv
+        - read_flatgeobuf
+        - read_geojson
diff --git a/python/core/docs/api/table.md b/python/core/docs/api/table.md
@@ -0,0 +1,9 @@
+# GeoTable
+
+::: geoarrow.rust.core.rust
+    options:
+      filters:
+        - "!^_"
+        - "^__arrow"
+      members:
+        - GeoTable
diff --git a/python/core/docs/index.md b/python/core/docs/index.md
diff --git a/python/core/docs/index.md b/python/core/docs/index.md
@@ -0,0 +1 @@
+../README.md