Add arrow-based API docs

stac-utils · Jun 21, 2024 · 5ee4746 · 5ee4746
1 parent 35c091b
commit 5ee4746
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 3 deletions.
diff --git a/docs/api/arrow.md b/docs/api/arrow.md
@@ -0,0 +1,5 @@
+# `stac_geoparquet.arrow`
+
+Arrow-based format conversions.
+
+::: stac_geoparquet.arrow
diff --git a/docs/usage.md b/docs/usage.md
@@ -0,0 +1,2 @@
+# Usage
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -15,10 +15,12 @@ extra:
     provider: mike
 
 nav:
-  - "index.md"
+  - index.md
+  - usage.md
   - Specification: spec/stac-geoparquet-spec.md
   - API Reference:
-      - api/legacy.md
+      - api/arrow.md
+      - Legacy: api/legacy.md
       # - api/pgstac.md
 
 watch:
@@ -74,7 +76,6 @@ plugins:
       enable_inventory: true
       handlers:
         python:
-          paths: [stac_geoparquet]
           options:
             docstring_section_style: list
             docstring_style: google

diff --git a/stac_geoparquet/arrow/__init__.py b/stac_geoparquet/arrow/__init__.py
@@ -11,3 +11,16 @@
 )
 from ._delta_lake import parse_stac_ndjson_to_delta_lake
 from ._to_parquet import parse_stac_ndjson_to_parquet, to_parquet
+
+__all__ = (
+    "DEFAULT_JSON_CHUNK_SIZE",
+    "DEFAULT_PARQUET_SCHEMA_VERSION",
+    "parse_stac_items_to_arrow",
+    "parse_stac_ndjson_to_arrow",
+    "parse_stac_ndjson_to_delta_lake",
+    "parse_stac_ndjson_to_parquet",
+    "stac_table_to_items",
+    "stac_table_to_ndjson",
+    "SUPPORTED_PARQUET_SCHEMA_VERSIONS",
+    "to_parquet",
+)