This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sedona.git
The following commit(s) were added to refs/heads/master by this push:
new 9ff9ade58c [DOC] Fix documentation structure after moving
sedona.geopandas to sedona.spark.geopandas (#2249)
9ff9ade58c is described below
commit 9ff9ade58c4a9d3263928095649a9aba92d8ed2d
Author: Feng Zhang <[email protected]>
AuthorDate: Thu Aug 7 21:34:11 2025 -0700
[DOC] Fix documentation structure after moving sedona.geopandas to
sedona.spark.geopandas (#2249)
---
python/sedona/doc/index.rst | 2 +-
python/sedona/doc/sedona.rst | 1 -
python/sedona/doc/sedona.spark.geopandas.api.rst | 20 +++++++
python/sedona/doc/sedona.spark.geopandas.rst | 61 ++++++++++++++++++++++
python/sedona/doc/sedona.spark.geopandas.tools.rst | 21 ++++++++
python/sedona/doc/sedona.spark.rst | 1 +
6 files changed, 104 insertions(+), 2 deletions(-)
diff --git a/python/sedona/doc/index.rst b/python/sedona/doc/index.rst
index 4bd430c541..f278aa612b 100644
--- a/python/sedona/doc/index.rst
+++ b/python/sedona/doc/index.rst
@@ -32,8 +32,8 @@ This documentation covers the Python API for Apache Sedona,
providing comprehens
modules
sedona.flink
- sedona.geopandas
sedona.spark
+ sedona.spark.geopandas
sedona.stac
sedona.stats
sedona.utils
diff --git a/python/sedona/doc/sedona.rst b/python/sedona/doc/sedona.rst
index 95ced1a4bc..ec7e1e4ce2 100644
--- a/python/sedona/doc/sedona.rst
+++ b/python/sedona/doc/sedona.rst
@@ -10,7 +10,6 @@ Subpackages
sedona.core
sedona.flink
sedona.geoarrow
- sedona.geopandas
sedona.maps
sedona.raster
sedona.raster_utils
diff --git a/python/sedona/doc/sedona.spark.geopandas.api.rst
b/python/sedona/doc/sedona.spark.geopandas.api.rst
new file mode 100644
index 0000000000..9a9097b23a
--- /dev/null
+++ b/python/sedona/doc/sedona.spark.geopandas.api.rst
@@ -0,0 +1,20 @@
+sedona.spark.geopandas package
+==============================
+
+.. Option: inherited-members: Series
+ Document all methods from the parent base 'GeoFrame' class, but ignore the
methods in 'Series' class
+.. autoclass:: sedona.spark.geopandas.GeoSeries
+ :members:
+ :undoc-members:
+
+ :inherited-members: Series
+
+.. autoclass:: sedona.spark.geopandas.GeoDataFrame
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+.. autoclass:: sedona.spark.geopandas.sindex.SpatialIndex
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/python/sedona/doc/sedona.spark.geopandas.rst
b/python/sedona/doc/sedona.spark.geopandas.rst
new file mode 100644
index 0000000000..30e9080fc4
--- /dev/null
+++ b/python/sedona/doc/sedona.spark.geopandas.rst
@@ -0,0 +1,61 @@
+sedona.spark.geopandas package
+==============================
+
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ sedona.spark.geopandas.tools
+
+Submodules
+----------
+
+sedona.spark.geopandas.base module
+-----------------------------------
+
+.. automodule:: sedona.spark.geopandas.base
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.spark.geopandas.geodataframe module
+-------------------------------------------
+
+.. automodule:: sedona.spark.geopandas.geodataframe
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.spark.geopandas.geoseries module
+----------------------------------------
+
+.. automodule:: sedona.spark.geopandas.geoseries
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.spark.geopandas.io module
+---------------------------------
+
+.. automodule:: sedona.spark.geopandas.io
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.spark.geopandas.sindex module
+-------------------------------------
+
+.. automodule:: sedona.spark.geopandas.sindex
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: sedona.spark.geopandas
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.geopandas.tools.rst
b/python/sedona/doc/sedona.spark.geopandas.tools.rst
new file mode 100644
index 0000000000..7f8098ccd9
--- /dev/null
+++ b/python/sedona/doc/sedona.spark.geopandas.tools.rst
@@ -0,0 +1,21 @@
+sedona.spark.geopandas.tools package
+=====================================
+
+Submodules
+----------
+
+sedona.spark.geopandas.tools.sjoin module
+------------------------------------------
+
+.. automodule:: sedona.spark.geopandas.tools.sjoin
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: sedona.spark.geopandas.tools
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.rst
b/python/sedona/doc/sedona.spark.rst
index 54e28c360b..fedb364c07 100644
--- a/python/sedona/doc/sedona.spark.rst
+++ b/python/sedona/doc/sedona.spark.rst
@@ -9,6 +9,7 @@ Subpackages
sedona.spark.core
sedona.spark.geoarrow
+ sedona.spark.geopandas
sedona.spark.maps
sedona.spark.raster
sedona.spark.raster_utils
