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 75b8fcdf39 [CI] Fix the python api build failed to import module
errors (#2196)
75b8fcdf39 is described below
commit 75b8fcdf3982c63a938dc3aa9b049bc6bc8630d5
Author: Feng Zhang <[email protected]>
AuthorDate: Thu Jul 31 11:08:21 2025 -0700
[CI] Fix the python api build failed to import module errors (#2196)
* [CI] Fix the python api build failed to import module errors
e.g.,
WARNING: autodoc: failed to import class 'geopandas.GeoSeries' from module
'sedona'; the following exception was raised:
['Traceback (most recent call last):\n', ' File
"/opt/hostedtoolcache/Python/3.13.5/x64/lib/python3.13/site-packages/sphinx/ext/autodoc/importer.py",
line 269, in import_object\n module = import_module(modname,
try_reload=True)\n', ' File
"/opt/hostedtoolcache/Python/3.13.5/x64/lib/python3.13/site-packages/sphinx/ext/autodoc/importer.py",
line 175, in import_module\n module = importlib.import_module(modname)\n',
' File "/opt/hostedtoolcache/Python/3.13.5/x64/lib/python3.13/im [...]
WARNING: autodoc: failed to import module
'spark.core.SpatialRDD.spatial_rdd_factory' from module 'sedona'
* fix pre-commit lint
* disable git debug task
* keplergl dependency is not compatible with Python 3.13
* Disabled strict error handling in CI
* use python 3.11
* remove build artifact file
* add error handling
* revert changes to python version
* reduce the mocking and try a different strategy
* use 3.11 python runtime
* exclude raster_utils.rst
* add deprecation message to sedona.* pakages to move to sedona.spark.*
* more deprecation messages
* suppress docstring (docutils) warnings
* temp disable raster and register to debug
* exclude spark sql
* only exclude sedona.spark.sql
* remove env CI
* install pyspark==3.5.4
* enable sedona.spark.sql
* try clean up a few more things
* add pystac 1.13.0
* revert origin builds
* fix pre-commit lint
* add back mock imports
* address pr review comments
* fix docstring comments
---
.github/workflows/docs.yml | 16 +++-
python/sedona/doc/_static/custom.css | 81 ++++++++++++++++--
python/sedona/doc/conf.py | 96 +++++++++++++++++++++-
python/sedona/doc/sedona.core.SpatialRDD.rst | 13 +++
python/sedona/doc/sedona.core.enums.rst | 13 +++
python/sedona/doc/sedona.core.formatMapper.rst | 32 ++++++++
.../sedona.core.formatMapper.shapefileParser.rst | 21 +++++
python/sedona/doc/sedona.core.geom.rst | 40 +++++++++
python/sedona/doc/sedona.core.jvm.rst | 24 ++++++
python/sedona/doc/sedona.core.rst | 26 ++++++
python/sedona/doc/sedona.core.spatialOperator.rst | 13 +++
python/sedona/doc/sedona.flink.rst | 7 +-
python/sedona/doc/sedona.geoarrow.rst | 13 +++
python/sedona/doc/sedona.geopandas.rst | 58 ++++++++++++-
python/sedona/doc/sedona.geopandas.tools.rst | 14 ++++
python/sedona/doc/sedona.maps.rst | 32 ++++++++
python/sedona/doc/sedona.raster.rst | 64 +++++++++++++++
python/sedona/doc/sedona.raster_utils.rst | 24 ++++++
python/sedona/doc/sedona.register.rst | 13 +++
python/sedona/doc/sedona.rst | 26 +++++-
python/sedona/doc/sedona.spark.core.SpatialRDD.rst | 16 ++--
python/sedona/doc/sedona.spark.core.enums.rst | 12 +--
.../sedona/doc/sedona.spark.core.formatMapper.rst | 12 +--
...ona.spark.core.formatMapper.shapefileParser.rst | 4 +-
python/sedona/doc/sedona.spark.core.geom.rst | 8 +-
.../sedona/doc/sedona.spark.core.geom.shapely1.rst | 6 +-
.../sedona/doc/sedona.spark.core.geom.shapely2.rst | 6 +-
python/sedona/doc/sedona.spark.core.jvm.rst | 8 +-
python/sedona/doc/sedona.spark.core.rst | 4 +-
.../doc/sedona.spark.core.spatialOperator.rst | 16 ++--
python/sedona/doc/sedona.spark.geoarrow.rst | 4 +-
python/sedona/doc/sedona.spark.maps.rst | 8 +-
python/sedona/doc/sedona.spark.raster.rst | 14 ++--
python/sedona/doc/sedona.spark.raster_utils.rst | 4 +-
python/sedona/doc/sedona.spark.register.rst | 6 +-
python/sedona/doc/sedona.spark.rst | 4 +-
python/sedona/doc/sedona.spark.sql.rst | 20 ++---
python/sedona/doc/sedona.spark.stac.rst | 6 +-
.../doc/sedona.spark.stats.autocorrelation.rst | 21 +++++
.../sedona/doc/sedona.spark.stats.clustering.rst | 4 +-
.../doc/sedona.spark.stats.hotspot_detection.rst | 4 +-
.../doc/sedona.spark.stats.outlier_detection.rst | 4 +-
python/sedona/doc/sedona.spark.stats.rst | 5 +-
python/sedona/doc/sedona.spark.utils.rst | 36 ++++----
python/sedona/doc/sedona.sql.rst | 53 ++++++++++++
python/sedona/doc/sedona.stac.rst | 24 +++++-
.../sedona/doc/sedona.stats.clustering.dbscan.rst | 2 +-
python/sedona/doc/sedona.stats.clustering.rst | 2 +-
.../sedona.stats.hotspot_detection.getis_ord.rst | 2 +-
.../sedona/doc/sedona.stats.hotspot_detection.rst | 13 ++-
...tats.outlier_detection.local_outlier_factor.rst | 2 +-
.../sedona/doc/sedona.stats.outlier_detection.rst | 2 +-
python/sedona/doc/sedona.stats.rst | 5 +-
python/sedona/doc/sedona.stats.weighting.rst | 2 +-
python/sedona/doc/sedona.utils.rst | 25 +++++-
.../sedona/doc/sedona.utils.structured_adapter.rst | 2 +-
python/sedona/geopandas/io.py | 4 -
python/sedona/spark/stac/client.py | 2 +-
58 files changed, 861 insertions(+), 137 deletions(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 532f553629..2dd4a108be 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -51,7 +51,7 @@ jobs:
run: mvn generate-sources scala:doc -pl !common,!snowflake,!flink &&
mkdir -p docs/api/scaladoc/spark && cp -r spark/common/target/site/scaladocs/*
docs/api/scaladoc/spark
- uses: actions/setup-python@v5
with:
- python-version: 3.x
+ python-version: '3.11'
- run: pip install -r requirements-docs.txt
- run: sudo apt update
- uses: r-lib/actions/[email protected]
@@ -67,8 +67,20 @@ jobs:
working-directory: './R'
- run: Rscript -e 'pkgdown::build_site(pkg = "./R", preview = FALSE,
override = list(destination = "../docs/api/rdocs"))'
- name: Install Python documentation dependencies
- run: pip install sphinx sphinx_rtd_theme
+ run: |
+ # Get Spark version from pom.xml
+ SPARK_VERSION=$(mvn help:evaluate -Dexpression=spark.version -q
-DforceStdout)
+
+ # Install Sphinx and dependencies with the correct PySpark version
+ pip install sphinx sphinx_rtd_theme pyspark==$SPARK_VERSION
+
+ # Install sedona with all optional dependencies for complete
documentation
+ cd python
+ pip install -e ".[all]"
+ cd ..
- name: Build Python API documentation with Sphinx
+ env:
+ CI: true
run: |
cd python/sedona/doc
make clean
diff --git a/python/sedona/doc/_static/custom.css
b/python/sedona/doc/_static/custom.css
index e278f3dc98..92d25a734b 100644
--- a/python/sedona/doc/_static/custom.css
+++ b/python/sedona/doc/_static/custom.css
@@ -8,7 +8,7 @@
--sedona-accent-dark: #333333;
--sedona-secondary: #e0e0e0;
--sedona-text: #333333;
- --sedona-light-gray: #f5f5f5;
+ --sedona-light-gray: #263238;
--sedona-white: #ffffff;
--sedona-dark: #263238;
}
@@ -66,10 +66,66 @@ body {
.wy-menu-vertical .toctree-l2 > a {
padding-left: 40px !important;
+ background: rgba(0, 0, 0, 0.4) !important;
+ color: #ffffff !important;
+}
+
+.wy-menu-vertical .toctree-l2 > a:hover {
+ background: rgba(0, 0, 0, 0.6) !important;
+ color: #ffffff !important;
+}
+
+.wy-menu-vertical .toctree-l2.current > a {
+ background: var(--sedona-primary) !important;
+ color: var(--sedona-white) !important;
}
.wy-menu-vertical .toctree-l3 > a {
padding-left: 56px !important;
+ background: rgba(0, 0, 0, 0.5) !important;
+ color: #ffffff !important;
+}
+
+.wy-menu-vertical .toctree-l3 > a:hover {
+ background: rgba(0, 0, 0, 0.7) !important;
+ color: #ffffff !important;
+}
+
+.wy-menu-vertical .toctree-l3.current > a {
+ background: var(--sedona-primary) !important;
+ color: var(--sedona-white) !important;
+}
+
+/* Fix for deeper navigation levels (l4, l5, etc.) */
+.wy-menu-vertical .toctree-l4 > a,
+.wy-menu-vertical .toctree-l5 > a,
+.wy-menu-vertical .toctree-l6 > a {
+ padding-left: 72px !important;
+ background: rgba(0, 0, 0, 0.6) !important;
+ color: #ffffff !important;
+}
+
+.wy-menu-vertical .toctree-l4 > a:hover,
+.wy-menu-vertical .toctree-l5 > a:hover,
+.wy-menu-vertical .toctree-l6 > a:hover {
+ background: rgba(0, 0, 0, 0.8) !important;
+ color: #ffffff !important;
+}
+
+.wy-menu-vertical .toctree-l4.current > a,
+.wy-menu-vertical .toctree-l5.current > a,
+.wy-menu-vertical .toctree-l6.current > a {
+ background: var(--sedona-primary) !important;
+ color: var(--sedona-white) !important;
+}
+
+/* Fix for any remaining navigation items that might have poor contrast */
+.wy-menu-vertical li a {
+ color: #ffffff !important;
+}
+
+.wy-menu-vertical li a:hover {
+ color: #ffffff !important;
}
/* Hide Contents: caption in left navigation bar */
@@ -120,8 +176,8 @@ h3 {
/* Code Blocks */
.highlight {
- background: var(--sedona-light-gray) !important;
- border: 1px solid var(--sedona-secondary) !important;
+ background: var(--sedona-dark) !important;
+ border: 1px solid var(--sedona-accent-dark) !important;
border-radius: 4px !important;
margin: 1rem 0 !important;
}
@@ -130,11 +186,12 @@ h3 {
background: transparent !important;
border: none !important;
padding: 16px !important;
+ color: var(--sedona-white) !important;
}
code {
- background: var(--sedona-light-gray) !important;
- color: var(--sedona-primary-dark) !important;
+ background: var(--sedona-dark) !important;
+ color: var(--sedona-white) !important;
padding: 2px 4px !important;
border-radius: 3px !important;
font-family: 'Roboto Mono', 'Consolas', 'Monaco', monospace !important;
@@ -149,7 +206,8 @@ code {
}
.wy-table-responsive table th {
- background: var(--sedona-light-gray) !important;
+ background: var(--sedona-dark) !important;
+ color: var(--sedona-white) !important;
font-weight: 500 !important;
}
@@ -242,6 +300,12 @@ a:hover {
background: var(--sedona-primary) !important;
}
+.wy-side-nav-search .wy-dropdown > a,
+.wy-side-nav-search > a {
+ color: var(--sedona-white) !important;
+ font-weight: 500 !important;
+}
+
.wy-side-nav-search input[type=text] {
border: 1px solid rgba(255, 255, 255, 0.2) !important;
background: rgba(255, 255, 255, 0.1) !important;
@@ -280,8 +344,9 @@ a:hover {
/* Version notice styling */
.version {
- background: var(--sedona-light-gray);
- border: 1px solid var(--sedona-secondary);
+ background: var(--sedona-dark);
+ color: var(--sedona-white);
+ border: 1px solid var(--sedona-accent-dark);
border-radius: 4px;
padding: 12px;
margin: 1rem 0;
diff --git a/python/sedona/doc/conf.py b/python/sedona/doc/conf.py
index 60467b59ab..d5f29e56b9 100644
--- a/python/sedona/doc/conf.py
+++ b/python/sedona/doc/conf.py
@@ -36,11 +36,13 @@ extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon", # For Google-style or NumPy-style docstrings
"sphinx.ext.viewcode", # Adds links to source code
+ "sphinx.ext.intersphinx", # Link to other projects' documentation
"sphinx_rtd_theme", # Read the Docs theme
]
# Mock imports to handle NumPy 2.0 compatibility issues with PySpark and
missing dependencies
-autodoc_mock_imports = [
+# These are needed even in CI because of NumPy 2.0 incompatibility in PySpark
+_base_mock_imports = [
"pyspark.pandas",
"pyspark.pandas.indexes",
"pyspark.pandas.indexes.base",
@@ -51,6 +53,13 @@ autodoc_mock_imports = [
"sedona.spark.raster.sedona_raster",
]
+# Use the same mocking for both CI and local development
+autodoc_mock_imports = _base_mock_imports + [
+ "keplergl",
+ "pydeck",
+ "rasterio",
+]
+
templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
@@ -61,16 +70,101 @@ suppress_warnings = [
# Suppress warnings about multiple targets for cross-references
# This is expected due to shapely1/shapely2 compatibility layer
"ref.python",
+ # Suppress docstring formatting warnings
+ "docutils",
+ # Suppress specific autodoc import errors that occur due to IndexError
+ "autodoc.import_object",
]
+# Don't treat warnings as errors to avoid IndexError issues
+warning_is_error = False
+# Be less strict about references to avoid import errors
+nitpicky = False
+
autodoc_default_options = {
"members": True,
"undoc-members": True,
"private-members": False,
"special-members": "__init__",
"show-inheritance": True,
+ "ignore-module-all": False,
+}
+
+# Configure autodoc to be more forgiving with import errors
+autodoc_inherit_docstrings = True
+autodoc_preserve_defaults = True
+
+
+# Add error handling for problematic imports in CI
+def skip_member(app, what, name, obj, skip, options):
+ """Skip problematic members that cause IndexError during documentation
build.
+
+ This is a Sphinx autodoc-skip-member event handler that filters out members
+ known to cause import issues during documentation generation.
+
+ Parameters
+ ----------
+ app : sphinx.application.Sphinx
+ The Sphinx application instance.
+ what : str
+ The type of the object being documented. Can be one of:
+ 'module', 'class', 'exception', 'function', 'method', 'attribute'.
+ name : str
+ The fully qualified name of the object being documented.
+ obj : Any
+ The actual Python object being documented. May be None if the object
+ couldn't be imported.
+ skip : bool
+ Whether the member was already marked to be skipped by previous
handlers
+ or Sphinx's default behavior.
+ options : dict
+ The autodoc options for this object (e.g., :members:, :undoc-members:).
+
+ Returns
+ -------
+ bool
+ True if the member should be skipped, False if it should be documented.
+ If skip is already True, this function preserves that decision.
+ """
+ # Skip members that are known to cause import issues
+ problematic_patterns = ["raster_serde", "sedona_raster", "shapely1",
"shapely2"]
+ if any(pattern in name for pattern in problematic_patterns):
+ return True
+ return skip
+
+
+def setup(app):
+ """Configure Sphinx app with error handling."""
+ app.connect("autodoc-skip-member", skip_member)
+
+
+# Intersphinx mapping to external documentation
+intersphinx_mapping = {
+ "python": ("https://docs.python.org/3";, None),
+ "numpy": ("https://numpy.org/doc/stable";, None),
+ "pandas": ("https://pandas.pydata.org/pandas-docs/stable";, None),
+ "shapely": ("https://shapely.readthedocs.io/en/stable";, None),
+ "geopandas": ("https://geopandas.org/en/stable";, None),
+ "pyspark": ("https://spark.apache.org/docs/latest/api/python";, None),
}
+# Type aliases for common PySpark types that might not resolve properly
+autodoc_type_aliases = {
+ "DataFrame": "pyspark.sql.DataFrame",
+ "SparkSession": "pyspark.sql.SparkSession",
+ "StructType": "pyspark.sql.types.StructType",
+ "StructField": "pyspark.sql.types.StructField",
+}
+
+# Suppress warnings for known unresolvable references
+nitpick_ignore = [
+ ("py:class", "pyspark.sql.dataframe.DataFrame"),
+ ("py:class", "pyspark.sql.session.SparkSession"),
+ ("py:class", "pyspark.sql.types.StructType"),
+ ("py:class", "pyspark.sql.types.StructField"),
+ ("py:class", "pyspark.rdd.RDD"),
+]
+
# -- Options for HTML output -------------------------------------------------
html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]
diff --git a/python/sedona/doc/sedona.core.SpatialRDD.rst
b/python/sedona/doc/sedona.core.SpatialRDD.rst
new file mode 100644
index 0000000000..9ba79bfa6e
--- /dev/null
+++ b/python/sedona/doc/sedona.core.SpatialRDD.rst
@@ -0,0 +1,13 @@
+sedona.core.SpatialRDD package
+==============================
+
+.. deprecated:: 1.8.0
+ The ``sedona.core.SpatialRDD`` package is deprecated. Please use
``sedona.spark.core.SpatialRDD`` instead.
+
+Module contents
+---------------
+
+.. automodule:: sedona.core.SpatialRDD
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.core.enums.rst
b/python/sedona/doc/sedona.core.enums.rst
new file mode 100644
index 0000000000..0e5ab1af64
--- /dev/null
+++ b/python/sedona/doc/sedona.core.enums.rst
@@ -0,0 +1,13 @@
+sedona.core.enums package
+=========================
+
+.. deprecated:: 1.8.0
+ The ``sedona.core.enums`` package is deprecated. Please use
``sedona.spark.core.enums`` instead.
+
+Module contents
+---------------
+
+.. automodule:: sedona.core.enums
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.core.formatMapper.rst
b/python/sedona/doc/sedona.core.formatMapper.rst
new file mode 100644
index 0000000000..7052957122
--- /dev/null
+++ b/python/sedona/doc/sedona.core.formatMapper.rst
@@ -0,0 +1,32 @@
+sedona.core.formatMapper package
+================================
+
+.. deprecated:: 1.8.0
+ The ``sedona.core.formatMapper`` package is deprecated. Please use
``sedona.spark.core.formatMapper`` instead.
+
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ sedona.core.formatMapper.shapefileParser
+
+Submodules
+----------
+
+sedona.core.formatMapper.geo\_json\_reader module
+-------------------------------------------------
+
+.. automodule:: sedona.core.formatMapper.geo_json_reader
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: sedona.core.formatMapper
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.core.formatMapper.shapefileParser.rst
b/python/sedona/doc/sedona.core.formatMapper.shapefileParser.rst
new file mode 100644
index 0000000000..1e7d3757e5
--- /dev/null
+++ b/python/sedona/doc/sedona.core.formatMapper.shapefileParser.rst
@@ -0,0 +1,21 @@
+sedona.core.formatMapper.shapefileParser package
+================================================
+
+Submodules
+----------
+
+sedona.core.formatMapper.shapefileParser.shape\_file\_reader module
+-------------------------------------------------------------------
+
+.. automodule:: sedona.core.formatMapper.shapefileParser.shape_file_reader
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: sedona.core.formatMapper.shapefileParser
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.core.geom.rst
b/python/sedona/doc/sedona.core.geom.rst
new file mode 100644
index 0000000000..09120e36f8
--- /dev/null
+++ b/python/sedona/doc/sedona.core.geom.rst
@@ -0,0 +1,40 @@
+sedona.core.geom package
+========================
+
+.. deprecated:: 1.8.0
+ The ``sedona.core.geom`` package is deprecated. Please use
``sedona.spark.core.geom`` instead.
+
+Submodules
+----------
+
+sedona.core.geom.circle module
+------------------------------
+
+.. automodule:: sedona.core.geom.circle
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.core.geom.envelope module
+--------------------------------
+
+.. automodule:: sedona.core.geom.envelope
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.core.geom.geography module
+---------------------------------
+
+.. automodule:: sedona.core.geom.geography
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: sedona.core.geom
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.core.jvm.rst
b/python/sedona/doc/sedona.core.jvm.rst
new file mode 100644
index 0000000000..6a88f90955
--- /dev/null
+++ b/python/sedona/doc/sedona.core.jvm.rst
@@ -0,0 +1,24 @@
+sedona.core.jvm package
+=======================
+
+.. deprecated:: 1.8.0
+ The ``sedona.core.jvm`` package is deprecated. Please use
``sedona.spark.core.jvm`` instead.
+
+Submodules
+----------
+
+sedona.core.jvm.config module
+-----------------------------
+
+.. automodule:: sedona.core.jvm.config
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: sedona.core.jvm
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.core.rst
b/python/sedona/doc/sedona.core.rst
new file mode 100644
index 0000000000..e326fb1c26
--- /dev/null
+++ b/python/sedona/doc/sedona.core.rst
@@ -0,0 +1,26 @@
+sedona.core package
+===================
+
+.. deprecated:: 1.8.0
+ The ``sedona.core`` package is deprecated. Please use ``sedona.spark.core``
instead.
+
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ sedona.core.SpatialRDD
+ sedona.core.enums
+ sedona.core.formatMapper
+ sedona.core.geom
+ sedona.core.jvm
+ sedona.core.spatialOperator
+
+Module contents
+---------------
+
+.. automodule:: sedona.core
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.core.spatialOperator.rst
b/python/sedona/doc/sedona.core.spatialOperator.rst
new file mode 100644
index 0000000000..aa31aade81
--- /dev/null
+++ b/python/sedona/doc/sedona.core.spatialOperator.rst
@@ -0,0 +1,13 @@
+sedona.core.spatialOperator package
+===================================
+
+.. deprecated:: 1.8.0
+ The ``sedona.core.spatialOperator`` package is deprecated. Please use
``sedona.spark.core.spatialOperator`` instead.
+
+Module contents
+---------------
+
+.. automodule:: sedona.core.spatialOperator
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.flink.rst
b/python/sedona/doc/sedona.flink.rst
index 91401bf362..cd141d6747 100644
--- a/python/sedona/doc/sedona.flink.rst
+++ b/python/sedona/doc/sedona.flink.rst
@@ -1,6 +1,9 @@
sedona.flink package
====================
+.. deprecated:: 1.8.0
+ The ``sedona.flink`` package is deprecated. Please use ``sedona.spark``
instead.
+
Submodules
----------
@@ -9,13 +12,13 @@ sedona.flink.context module
.. automodule:: sedona.flink.context
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.flink
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.geoarrow.rst
b/python/sedona/doc/sedona.geoarrow.rst
new file mode 100644
index 0000000000..d1b27f0968
--- /dev/null
+++ b/python/sedona/doc/sedona.geoarrow.rst
@@ -0,0 +1,13 @@
+sedona.geoarrow package
+=======================
+
+.. deprecated:: 1.8.0
+ The ``sedona.geoarrow`` package is deprecated. Please use
``sedona.spark.geoarrow`` instead.
+
+Module contents
+---------------
+
+.. automodule:: sedona.geoarrow
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.geopandas.rst
b/python/sedona/doc/sedona.geopandas.rst
index 81ef43ee86..e302a9c6e9 100644
--- a/python/sedona/doc/sedona.geopandas.rst
+++ b/python/sedona/doc/sedona.geopandas.rst
@@ -1,9 +1,61 @@
sedona.geopandas package
========================
-.. toctree::
- :maxdepth: 2
+Subpackages
+-----------
- sedona.geopandas.api
+.. toctree::
+ :maxdepth: 4
sedona.geopandas.tools
+
+Submodules
+----------
+
+sedona.geopandas.base module
+----------------------------
+
+.. automodule:: sedona.geopandas.base
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.geopandas.geodataframe module
+------------------------------------
+
+.. automodule:: sedona.geopandas.geodataframe
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.geopandas.geoseries module
+---------------------------------
+
+.. automodule:: sedona.geopandas.geoseries
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.geopandas.io module
+--------------------------
+
+.. automodule:: sedona.geopandas.io
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.geopandas.sindex module
+------------------------------
+
+.. automodule:: sedona.geopandas.sindex
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: sedona.geopandas
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.geopandas.tools.rst
b/python/sedona/doc/sedona.geopandas.tools.rst
index 0d52c5f911..e00dd02942 100644
--- a/python/sedona/doc/sedona.geopandas.tools.rst
+++ b/python/sedona/doc/sedona.geopandas.tools.rst
@@ -1,7 +1,21 @@
sedona.geopandas.tools package
==============================
+Submodules
+----------
+
+sedona.geopandas.tools.sjoin module
+-----------------------------------
+
.. automodule:: sedona.geopandas.tools.sjoin
:members:
+ :show-inheritance:
:undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: sedona.geopandas.tools
+ :members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.maps.rst
b/python/sedona/doc/sedona.maps.rst
new file mode 100644
index 0000000000..3d3390f90a
--- /dev/null
+++ b/python/sedona/doc/sedona.maps.rst
@@ -0,0 +1,32 @@
+sedona.maps package
+===================
+
+.. deprecated:: 1.8.0
+ The ``sedona.maps`` package is deprecated. Please use ``sedona.spark.maps``
instead.
+
+Submodules
+----------
+
+sedona.maps.SedonaKepler module
+-------------------------------
+
+.. automodule:: sedona.maps.SedonaKepler
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.maps.SedonaPyDeck module
+-------------------------------
+
+.. automodule:: sedona.maps.SedonaPyDeck
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: sedona.maps
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.raster.rst
b/python/sedona/doc/sedona.raster.rst
new file mode 100644
index 0000000000..45890a3095
--- /dev/null
+++ b/python/sedona/doc/sedona.raster.rst
@@ -0,0 +1,64 @@
+sedona.raster package
+=====================
+
+.. deprecated:: 1.8.0
+ The ``sedona.raster`` package is deprecated. Please use
``sedona.spark.raster`` instead.
+
+Submodules
+----------
+
+sedona.raster.awt\_raster module
+--------------------------------
+
+.. automodule:: sedona.raster.awt_raster
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.raster.data\_buffer module
+---------------------------------
+
+.. automodule:: sedona.raster.data_buffer
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.raster.meta module
+-------------------------
+
+.. automodule:: sedona.raster.meta
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.raster.raster\_serde module
+----------------------------------
+
+.. automodule:: sedona.raster.raster_serde
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.raster.sample\_model module
+----------------------------------
+
+.. automodule:: sedona.raster.sample_model
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.raster.sedona\_raster module
+-----------------------------------
+
+.. automodule:: sedona.raster.sedona_raster
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: sedona.raster
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.raster_utils.rst
b/python/sedona/doc/sedona.raster_utils.rst
new file mode 100644
index 0000000000..05b78d5a78
--- /dev/null
+++ b/python/sedona/doc/sedona.raster_utils.rst
@@ -0,0 +1,24 @@
+sedona.raster\_utils package
+============================
+
+.. deprecated:: 1.8.0
+ The ``sedona.raster_utils`` package is deprecated. Please use
``sedona.spark.raster_utils`` instead.
+
+Submodules
+----------
+
+sedona.raster\_utils.SedonaUtils module
+---------------------------------------
+
+.. automodule:: sedona.raster_utils.SedonaUtils
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: sedona.raster_utils
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.register.rst
b/python/sedona/doc/sedona.register.rst
new file mode 100644
index 0000000000..77b5a8f66d
--- /dev/null
+++ b/python/sedona/doc/sedona.register.rst
@@ -0,0 +1,13 @@
+sedona.register package
+=======================
+
+.. deprecated:: 1.8.0
+ The ``sedona.register`` package is deprecated. Please use
``sedona.spark.register`` instead.
+
+Module contents
+---------------
+
+.. automodule:: sedona.register
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.rst b/python/sedona/doc/sedona.rst
index d1508904d6..95ced1a4bc 100644
--- a/python/sedona/doc/sedona.rst
+++ b/python/sedona/doc/sedona.rst
@@ -1,6 +1,26 @@
sedona package
==============
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ sedona.core
+ sedona.flink
+ sedona.geoarrow
+ sedona.geopandas
+ sedona.maps
+ sedona.raster
+ sedona.raster_utils
+ sedona.register
+ sedona.spark
+ sedona.sql
+ sedona.stac
+ sedona.stats
+ sedona.utils
+
Submodules
----------
@@ -9,21 +29,21 @@ sedona.exceptions module
.. automodule:: sedona.exceptions
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.version module
---------------------
.. automodule:: sedona.version
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.core.SpatialRDD.rst
b/python/sedona/doc/sedona.spark.core.SpatialRDD.rst
index 62e1b4869b..2f68bbf32d 100644
--- a/python/sedona/doc/sedona.spark.core.SpatialRDD.rst
+++ b/python/sedona/doc/sedona.spark.core.SpatialRDD.rst
@@ -9,61 +9,61 @@ sedona.spark.core.SpatialRDD.circle\_rdd module
.. automodule:: sedona.spark.core.SpatialRDD.circle_rdd
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.SpatialRDD.linestring\_rdd module
---------------------------------------------------
.. automodule:: sedona.spark.core.SpatialRDD.linestring_rdd
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.SpatialRDD.point\_rdd module
----------------------------------------------
.. automodule:: sedona.spark.core.SpatialRDD.point_rdd
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.SpatialRDD.polygon\_rdd module
------------------------------------------------
.. automodule:: sedona.spark.core.SpatialRDD.polygon_rdd
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.SpatialRDD.rectangle\_rdd module
--------------------------------------------------
.. automodule:: sedona.spark.core.SpatialRDD.rectangle_rdd
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.SpatialRDD.spatial\_rdd module
------------------------------------------------
.. automodule:: sedona.spark.core.SpatialRDD.spatial_rdd
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.SpatialRDD.spatial\_rdd\_factory module
---------------------------------------------------------
.. automodule:: sedona.spark.core.SpatialRDD.spatial_rdd_factory
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.core.SpatialRDD
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.core.enums.rst
b/python/sedona/doc/sedona.spark.core.enums.rst
index fec09c90a0..8ff9e58aab 100644
--- a/python/sedona/doc/sedona.spark.core.enums.rst
+++ b/python/sedona/doc/sedona.spark.core.enums.rst
@@ -9,45 +9,45 @@ sedona.spark.core.enums.file\_data\_splitter module
.. automodule:: sedona.spark.core.enums.file_data_splitter
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.enums.grid\_type module
-----------------------------------------
.. automodule:: sedona.spark.core.enums.grid_type
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.enums.index\_type module
------------------------------------------
.. automodule:: sedona.spark.core.enums.index_type
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.enums.join\_build\_side module
------------------------------------------------
.. automodule:: sedona.spark.core.enums.join_build_side
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.enums.spatial module
--------------------------------------
.. automodule:: sedona.spark.core.enums.spatial
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.core.enums
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.core.formatMapper.rst
b/python/sedona/doc/sedona.spark.core.formatMapper.rst
index efa0b5ce26..114022d74e 100644
--- a/python/sedona/doc/sedona.spark.core.formatMapper.rst
+++ b/python/sedona/doc/sedona.spark.core.formatMapper.rst
@@ -17,45 +17,45 @@ sedona.spark.core.formatMapper.disc\_utils module
.. automodule:: sedona.spark.core.formatMapper.disc_utils
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.formatMapper.geo\_json\_reader module
-------------------------------------------------------
.. automodule:: sedona.spark.core.formatMapper.geo_json_reader
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.formatMapper.geo\_reader module
-------------------------------------------------
.. automodule:: sedona.spark.core.formatMapper.geo_reader
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.formatMapper.wkb\_reader module
-------------------------------------------------
.. automodule:: sedona.spark.core.formatMapper.wkb_reader
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.formatMapper.wkt\_reader module
-------------------------------------------------
.. automodule:: sedona.spark.core.formatMapper.wkt_reader
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.core.formatMapper
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git
a/python/sedona/doc/sedona.spark.core.formatMapper.shapefileParser.rst
b/python/sedona/doc/sedona.spark.core.formatMapper.shapefileParser.rst
index 292ce3d845..e6b061fef1 100644
--- a/python/sedona/doc/sedona.spark.core.formatMapper.shapefileParser.rst
+++ b/python/sedona/doc/sedona.spark.core.formatMapper.shapefileParser.rst
@@ -9,13 +9,13 @@
sedona.spark.core.formatMapper.shapefileParser.shape\_file\_reader module
.. automodule::
sedona.spark.core.formatMapper.shapefileParser.shape_file_reader
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.core.formatMapper.shapefileParser
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.core.geom.rst
b/python/sedona/doc/sedona.spark.core.geom.rst
index 2994eed8d3..4a00982f7c 100644
--- a/python/sedona/doc/sedona.spark.core.geom.rst
+++ b/python/sedona/doc/sedona.spark.core.geom.rst
@@ -18,29 +18,29 @@ sedona.spark.core.geom.circle module
.. automodule:: sedona.spark.core.geom.circle
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.geom.envelope module
--------------------------------------
.. automodule:: sedona.spark.core.geom.envelope
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.geom.geography module
---------------------------------------
.. automodule:: sedona.spark.core.geom.geography
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.core.geom
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.core.geom.shapely1.rst
b/python/sedona/doc/sedona.spark.core.geom.shapely1.rst
index 1b3de21f8c..c3416a4364 100644
--- a/python/sedona/doc/sedona.spark.core.geom.shapely1.rst
+++ b/python/sedona/doc/sedona.spark.core.geom.shapely1.rst
@@ -9,21 +9,21 @@ sedona.spark.core.geom.shapely1.circle module
.. automodule:: sedona.spark.core.geom.shapely1.circle
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.geom.shapely1.envelope module
-----------------------------------------------
.. automodule:: sedona.spark.core.geom.shapely1.envelope
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.core.geom.shapely1
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.core.geom.shapely2.rst
b/python/sedona/doc/sedona.spark.core.geom.shapely2.rst
index 6f514d831a..5ef87fae34 100644
--- a/python/sedona/doc/sedona.spark.core.geom.shapely2.rst
+++ b/python/sedona/doc/sedona.spark.core.geom.shapely2.rst
@@ -9,21 +9,21 @@ sedona.spark.core.geom.shapely2.circle module
.. automodule:: sedona.spark.core.geom.shapely2.circle
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.geom.shapely2.envelope module
-----------------------------------------------
.. automodule:: sedona.spark.core.geom.shapely2.envelope
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.core.geom.shapely2
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.core.jvm.rst
b/python/sedona/doc/sedona.spark.core.jvm.rst
index 879605f27e..db88b5eb10 100644
--- a/python/sedona/doc/sedona.spark.core.jvm.rst
+++ b/python/sedona/doc/sedona.spark.core.jvm.rst
@@ -9,29 +9,29 @@ sedona.spark.core.jvm.abstract module
.. automodule:: sedona.spark.core.jvm.abstract
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.jvm.config module
-----------------------------------
.. automodule:: sedona.spark.core.jvm.config
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.jvm.translate module
--------------------------------------
.. automodule:: sedona.spark.core.jvm.translate
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.core.jvm
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.core.rst
b/python/sedona/doc/sedona.spark.core.rst
index 59dcbed1a2..228449b911 100644
--- a/python/sedona/doc/sedona.spark.core.rst
+++ b/python/sedona/doc/sedona.spark.core.rst
@@ -22,13 +22,13 @@ sedona.spark.core.utils module
.. automodule:: sedona.spark.core.utils
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.core
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.core.spatialOperator.rst
b/python/sedona/doc/sedona.spark.core.spatialOperator.rst
index 819d4a58c5..15ed1e9244 100644
--- a/python/sedona/doc/sedona.spark.core.spatialOperator.rst
+++ b/python/sedona/doc/sedona.spark.core.spatialOperator.rst
@@ -9,61 +9,61 @@ sedona.spark.core.spatialOperator.join\_params module
.. automodule:: sedona.spark.core.spatialOperator.join_params
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.spatialOperator.join\_query module
----------------------------------------------------
.. automodule:: sedona.spark.core.spatialOperator.join_query
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.spatialOperator.join\_query\_raw module
---------------------------------------------------------
.. automodule:: sedona.spark.core.spatialOperator.join_query_raw
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.spatialOperator.knn\_query module
---------------------------------------------------
.. automodule:: sedona.spark.core.spatialOperator.knn_query
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.spatialOperator.range\_query module
-----------------------------------------------------
.. automodule:: sedona.spark.core.spatialOperator.range_query
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.spatialOperator.range\_query\_raw module
----------------------------------------------------------
.. automodule:: sedona.spark.core.spatialOperator.range_query_raw
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.core.spatialOperator.rdd module
--------------------------------------------
.. automodule:: sedona.spark.core.spatialOperator.rdd
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.core.spatialOperator
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.geoarrow.rst
b/python/sedona/doc/sedona.spark.geoarrow.rst
index 92efc5db52..7a6d7c7c07 100644
--- a/python/sedona/doc/sedona.spark.geoarrow.rst
+++ b/python/sedona/doc/sedona.spark.geoarrow.rst
@@ -9,13 +9,13 @@ sedona.spark.geoarrow.geoarrow module
.. automodule:: sedona.spark.geoarrow.geoarrow
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.geoarrow
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.maps.rst
b/python/sedona/doc/sedona.spark.maps.rst
index d445f3af5b..7530202929 100644
--- a/python/sedona/doc/sedona.spark.maps.rst
+++ b/python/sedona/doc/sedona.spark.maps.rst
@@ -9,29 +9,29 @@ sedona.spark.maps.SedonaKepler module
.. automodule:: sedona.spark.maps.SedonaKepler
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.maps.SedonaMapUtils module
---------------------------------------
.. automodule:: sedona.spark.maps.SedonaMapUtils
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.maps.SedonaPyDeck module
-------------------------------------
.. automodule:: sedona.spark.maps.SedonaPyDeck
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.maps
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.raster.rst
b/python/sedona/doc/sedona.spark.raster.rst
index 128c0ae692..6a83c49c0d 100644
--- a/python/sedona/doc/sedona.spark.raster.rst
+++ b/python/sedona/doc/sedona.spark.raster.rst
@@ -9,53 +9,53 @@ sedona.spark.raster.awt\_raster module
.. automodule:: sedona.spark.raster.awt_raster
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.raster.data\_buffer module
---------------------------------------
.. automodule:: sedona.spark.raster.data_buffer
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.raster.meta module
-------------------------------
.. automodule:: sedona.spark.raster.meta
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.raster.raster\_serde module
----------------------------------------
.. automodule:: sedona.spark.raster.raster_serde
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.raster.sample\_model module
----------------------------------------
.. automodule:: sedona.spark.raster.sample_model
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.raster.sedona\_raster module
-----------------------------------------
.. automodule:: sedona.spark.raster.sedona_raster
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.raster
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.raster_utils.rst
b/python/sedona/doc/sedona.spark.raster_utils.rst
index 10c8b2f995..178128a975 100644
--- a/python/sedona/doc/sedona.spark.raster_utils.rst
+++ b/python/sedona/doc/sedona.spark.raster_utils.rst
@@ -9,13 +9,13 @@ sedona.spark.raster\_utils.SedonaUtils module
.. automodule:: sedona.spark.raster_utils.SedonaUtils
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.raster_utils
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.register.rst
b/python/sedona/doc/sedona.spark.register.rst
index 84ce6d363b..51123ce32f 100644
--- a/python/sedona/doc/sedona.spark.register.rst
+++ b/python/sedona/doc/sedona.spark.register.rst
@@ -9,21 +9,21 @@ sedona.spark.register.geo\_registrator module
.. automodule:: sedona.spark.register.geo_registrator
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.register.java\_libs module
---------------------------------------
.. automodule:: sedona.spark.register.java_libs
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.register
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.rst
b/python/sedona/doc/sedona.spark.rst
index fead5fe7cb..54e28c360b 100644
--- a/python/sedona/doc/sedona.spark.rst
+++ b/python/sedona/doc/sedona.spark.rst
@@ -26,13 +26,13 @@ sedona.spark.SedonaContext module
.. automodule:: sedona.spark.SedonaContext
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.sql.rst
b/python/sedona/doc/sedona.spark.sql.rst
index ef677045d4..2161a3a778 100644
--- a/python/sedona/doc/sedona.spark.sql.rst
+++ b/python/sedona/doc/sedona.spark.sql.rst
@@ -9,77 +9,77 @@ sedona.spark.sql.connect module
.. automodule:: sedona.spark.sql.connect
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.sql.dataframe\_api module
--------------------------------------
.. automodule:: sedona.spark.sql.dataframe_api
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.sql.exceptions module
----------------------------------
.. automodule:: sedona.spark.sql.exceptions
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.sql.functions module
---------------------------------
.. automodule:: sedona.spark.sql.functions
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.sql.st\_aggregates module
--------------------------------------
.. automodule:: sedona.spark.sql.st_aggregates
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.sql.st\_constructors module
----------------------------------------
.. automodule:: sedona.spark.sql.st_constructors
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.sql.st\_functions module
-------------------------------------
.. automodule:: sedona.spark.sql.st_functions
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.sql.st\_predicates module
--------------------------------------
.. automodule:: sedona.spark.sql.st_predicates
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.sql.types module
-----------------------------
.. automodule:: sedona.spark.sql.types
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.sql
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.stac.rst
b/python/sedona/doc/sedona.spark.stac.rst
index 9091cffbf7..0b7d859be2 100644
--- a/python/sedona/doc/sedona.spark.stac.rst
+++ b/python/sedona/doc/sedona.spark.stac.rst
@@ -9,21 +9,21 @@ sedona.spark.stac.client module
.. automodule:: sedona.spark.stac.client
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.stac.collection\_client module
-------------------------------------------
.. automodule:: sedona.spark.stac.collection_client
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.stac
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.stats.autocorrelation.rst
b/python/sedona/doc/sedona.spark.stats.autocorrelation.rst
new file mode 100644
index 0000000000..715a8e3595
--- /dev/null
+++ b/python/sedona/doc/sedona.spark.stats.autocorrelation.rst
@@ -0,0 +1,21 @@
+sedona.spark.stats.autocorrelation package
+==========================================
+
+Submodules
+----------
+
+sedona.spark.stats.autocorrelation.moran module
+-----------------------------------------------
+
+.. automodule:: sedona.spark.stats.autocorrelation.moran
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: sedona.spark.stats.autocorrelation
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.stats.clustering.rst
b/python/sedona/doc/sedona.spark.stats.clustering.rst
index f6c0812d65..503d6678f7 100644
--- a/python/sedona/doc/sedona.spark.stats.clustering.rst
+++ b/python/sedona/doc/sedona.spark.stats.clustering.rst
@@ -9,13 +9,13 @@ sedona.spark.stats.clustering.dbscan module
.. automodule:: sedona.spark.stats.clustering.dbscan
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.stats.clustering
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.stats.hotspot_detection.rst
b/python/sedona/doc/sedona.spark.stats.hotspot_detection.rst
index 3bd0cdb33a..1e74ea10ed 100644
--- a/python/sedona/doc/sedona.spark.stats.hotspot_detection.rst
+++ b/python/sedona/doc/sedona.spark.stats.hotspot_detection.rst
@@ -9,13 +9,13 @@ sedona.spark.stats.hotspot\_detection.getis\_ord module
.. automodule:: sedona.spark.stats.hotspot_detection.getis_ord
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.stats.hotspot_detection
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.stats.outlier_detection.rst
b/python/sedona/doc/sedona.spark.stats.outlier_detection.rst
index ce54c43472..b31c6791c5 100644
--- a/python/sedona/doc/sedona.spark.stats.outlier_detection.rst
+++ b/python/sedona/doc/sedona.spark.stats.outlier_detection.rst
@@ -9,13 +9,13 @@ sedona.spark.stats.outlier\_detection.local\_outlier\_factor
module
.. automodule:: sedona.spark.stats.outlier_detection.local_outlier_factor
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.stats.outlier_detection
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.stats.rst
b/python/sedona/doc/sedona.spark.stats.rst
index c1af361602..653dd69765 100644
--- a/python/sedona/doc/sedona.spark.stats.rst
+++ b/python/sedona/doc/sedona.spark.stats.rst
@@ -7,6 +7,7 @@ Subpackages
.. toctree::
:maxdepth: 4
+ sedona.spark.stats.autocorrelation
sedona.spark.stats.clustering
sedona.spark.stats.hotspot_detection
sedona.spark.stats.outlier_detection
@@ -19,13 +20,13 @@ sedona.spark.stats.weighting module
.. automodule:: sedona.spark.stats.weighting
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.stats
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.spark.utils.rst
b/python/sedona/doc/sedona.spark.utils.rst
index a3b279ba80..1dd6eba1a9 100644
--- a/python/sedona/doc/sedona.spark.utils.rst
+++ b/python/sedona/doc/sedona.spark.utils.rst
@@ -9,117 +9,125 @@ sedona.spark.utils.abstract\_parser module
.. automodule:: sedona.spark.utils.abstract_parser
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.utils.adapter module
---------------------------------
.. automodule:: sedona.spark.utils.adapter
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.utils.binary\_parser module
----------------------------------------
.. automodule:: sedona.spark.utils.binary_parser
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.utils.decorators module
------------------------------------
.. automodule:: sedona.spark.utils.decorators
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.utils.geometry\_adapter module
-------------------------------------------
.. automodule:: sedona.spark.utils.geometry_adapter
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.utils.geometry\_serde module
-----------------------------------------
.. automodule:: sedona.spark.utils.geometry_serde
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.utils.geometry\_serde\_general module
--------------------------------------------------
.. automodule:: sedona.spark.utils.geometry_serde_general
:members:
+ :show-inheritance:
:undoc-members:
+
+sedona.spark.utils.geomserde\_speedup module
+--------------------------------------------
+
+.. automodule:: sedona.spark.utils.geomserde_speedup
+ :members:
:show-inheritance:
+ :undoc-members:
sedona.spark.utils.jvm module
-----------------------------
.. automodule:: sedona.spark.utils.jvm
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.utils.meta module
------------------------------
.. automodule:: sedona.spark.utils.meta
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.utils.prep module
------------------------------
.. automodule:: sedona.spark.utils.prep
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.utils.serde module
-------------------------------
.. automodule:: sedona.spark.utils.serde
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.utils.spatial\_rdd\_parser module
----------------------------------------------
.. automodule:: sedona.spark.utils.spatial_rdd_parser
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.utils.structured\_adapter module
---------------------------------------------
.. automodule:: sedona.spark.utils.structured_adapter
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
sedona.spark.utils.types module
-------------------------------
.. automodule:: sedona.spark.utils.types
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
Module contents
---------------
.. automodule:: sedona.spark.utils
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.sql.rst b/python/sedona/doc/sedona.sql.rst
new file mode 100644
index 0000000000..0f51e787d3
--- /dev/null
+++ b/python/sedona/doc/sedona.sql.rst
@@ -0,0 +1,53 @@
+sedona.sql package
+==================
+
+Submodules
+----------
+
+sedona.sql.st\_aggregates module
+--------------------------------
+
+.. automodule:: sedona.sql.st_aggregates
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.sql.st\_constructors module
+----------------------------------
+
+.. automodule:: sedona.sql.st_constructors
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.sql.st\_functions module
+-------------------------------
+
+.. automodule:: sedona.sql.st_functions
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.sql.st\_predicates module
+--------------------------------
+
+.. automodule:: sedona.sql.st_predicates
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.sql.types module
+-----------------------
+
+.. automodule:: sedona.sql.types
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: sedona.sql
+ :members:
+ :show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.stac.rst
b/python/sedona/doc/sedona.stac.rst
index 87ed579b98..c6f94e5398 100644
--- a/python/sedona/doc/sedona.stac.rst
+++ b/python/sedona/doc/sedona.stac.rst
@@ -1,10 +1,32 @@
sedona.stac package
===================
+.. deprecated:: 1.8.0
+ The ``sedona.stac`` package is deprecated. Please use ``sedona.spark.stac``
instead.
+
+Submodules
+----------
+
+sedona.stac.client module
+-------------------------
+
+.. automodule:: sedona.stac.client
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.stac.collection\_client module
+-------------------------------------
+
+.. automodule:: sedona.stac.collection_client
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
Module contents
---------------
.. automodule:: sedona.stac
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.stats.clustering.dbscan.rst
b/python/sedona/doc/sedona.stats.clustering.dbscan.rst
index 8264e84b02..b872d63252 100644
--- a/python/sedona/doc/sedona.stats.clustering.dbscan.rst
+++ b/python/sedona/doc/sedona.stats.clustering.dbscan.rst
@@ -6,5 +6,5 @@ Module contents
.. automodule:: sedona.stats.clustering.dbscan
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.stats.clustering.rst
b/python/sedona/doc/sedona.stats.clustering.rst
index a93d342385..0cb2a07662 100644
--- a/python/sedona/doc/sedona.stats.clustering.rst
+++ b/python/sedona/doc/sedona.stats.clustering.rst
@@ -14,5 +14,5 @@ Module contents
.. automodule:: sedona.stats.clustering
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.stats.hotspot_detection.getis_ord.rst
b/python/sedona/doc/sedona.stats.hotspot_detection.getis_ord.rst
index fb684d0ae9..05df0a7b17 100644
--- a/python/sedona/doc/sedona.stats.hotspot_detection.getis_ord.rst
+++ b/python/sedona/doc/sedona.stats.hotspot_detection.getis_ord.rst
@@ -6,5 +6,5 @@ Module contents
.. automodule:: sedona.stats.hotspot_detection.getis_ord
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.stats.hotspot_detection.rst
b/python/sedona/doc/sedona.stats.hotspot_detection.rst
index 08f38c220c..58ffb13c2a 100644
--- a/python/sedona/doc/sedona.stats.hotspot_detection.rst
+++ b/python/sedona/doc/sedona.stats.hotspot_detection.rst
@@ -9,10 +9,21 @@ Subpackages
sedona.stats.hotspot_detection.getis_ord
+Submodules
+----------
+
+sedona.stats.hotspot\_detection.getis\_ord module
+-------------------------------------------------
+
+.. automodule:: sedona.stats.hotspot_detection.getis_ord
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
Module contents
---------------
.. automodule:: sedona.stats.hotspot_detection
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git
a/python/sedona/doc/sedona.stats.outlier_detection.local_outlier_factor.rst
b/python/sedona/doc/sedona.stats.outlier_detection.local_outlier_factor.rst
index a3755e2e46..75cee2a581 100644
--- a/python/sedona/doc/sedona.stats.outlier_detection.local_outlier_factor.rst
+++ b/python/sedona/doc/sedona.stats.outlier_detection.local_outlier_factor.rst
@@ -6,5 +6,5 @@ Module contents
.. automodule:: sedona.stats.outlier_detection.local_outlier_factor
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.stats.outlier_detection.rst
b/python/sedona/doc/sedona.stats.outlier_detection.rst
index 9512f64120..7f655a2053 100644
--- a/python/sedona/doc/sedona.stats.outlier_detection.rst
+++ b/python/sedona/doc/sedona.stats.outlier_detection.rst
@@ -14,5 +14,5 @@ Module contents
.. automodule:: sedona.stats.outlier_detection
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.stats.rst
b/python/sedona/doc/sedona.stats.rst
index 72dca3cd80..a396ec8c86 100644
--- a/python/sedona/doc/sedona.stats.rst
+++ b/python/sedona/doc/sedona.stats.rst
@@ -1,6 +1,9 @@
sedona.stats package
====================
+.. deprecated:: 1.8.0
+ The ``sedona.stats`` package is deprecated. Please use
``sedona.spark.stats`` instead.
+
Subpackages
-----------
@@ -17,5 +20,5 @@ Module contents
.. automodule:: sedona.stats
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.stats.weighting.rst
b/python/sedona/doc/sedona.stats.weighting.rst
index 77e8da686c..afc6e1f19a 100644
--- a/python/sedona/doc/sedona.stats.weighting.rst
+++ b/python/sedona/doc/sedona.stats.weighting.rst
@@ -6,5 +6,5 @@ Module contents
.. automodule:: sedona.stats.weighting
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.utils.rst
b/python/sedona/doc/sedona.utils.rst
index 2bde4ee0fb..a9ad9fc10d 100644
--- a/python/sedona/doc/sedona.utils.rst
+++ b/python/sedona/doc/sedona.utils.rst
@@ -1,19 +1,40 @@
sedona.utils package
====================
+.. deprecated:: 1.8.0
+ The ``sedona.utils`` package is deprecated. Please use
``sedona.spark.utils`` instead.
+
Subpackages
-----------
.. toctree::
:maxdepth: 4
- sedona.utils.geoarrow
sedona.utils.structured_adapter
+Submodules
+----------
+
+sedona.utils.adapter module
+---------------------------
+
+.. automodule:: sedona.utils.adapter
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
+sedona.utils.spatial\_rdd\_parser module
+----------------------------------------
+
+.. automodule:: sedona.utils.spatial_rdd_parser
+ :members:
+ :show-inheritance:
+ :undoc-members:
+
Module contents
---------------
.. automodule:: sedona.utils
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/doc/sedona.utils.structured_adapter.rst
b/python/sedona/doc/sedona.utils.structured_adapter.rst
index bb8273eedc..1b97ea07ab 100644
--- a/python/sedona/doc/sedona.utils.structured_adapter.rst
+++ b/python/sedona/doc/sedona.utils.structured_adapter.rst
@@ -6,5 +6,5 @@ Module contents
.. automodule:: sedona.utils.structured_adapter
:members:
- :undoc-members:
:show-inheritance:
+ :undoc-members:
diff --git a/python/sedona/geopandas/io.py b/python/sedona/geopandas/io.py
index a9da89eef7..cbc5c136b8 100644
--- a/python/sedona/geopandas/io.py
+++ b/python/sedona/geopandas/io.py
@@ -163,10 +163,6 @@ def read_file(filename: str, format: Union[str, None] =
None, **kwargs):
- "geojson"
- "geopackage"
- "geoparquet"
-
- table_name : str, default None
- The name of the table to read from a geopackage file. Required if
format is geopackage.
-
See also
--------
GeoDataFrame.to_file : write GeoDataFrame to file
diff --git a/python/sedona/spark/stac/client.py
b/python/sedona/spark/stac/client.py
index 103dc65396..e7a9405a01 100644
--- a/python/sedona/spark/stac/client.py
+++ b/python/sedona/spark/stac/client.py
@@ -98,7 +98,7 @@ class Client:
- "YYYY-mm" expands to ["YYYY-mm-01T00:00:00Z",
"YYYY-mm-<last_day>T23:59:59Z"]
- "YYYY-mm-dd" expands to ["YYYY-mm-ddT00:00:00Z",
"YYYY-mm-ddT23:59:59Z"]
- "YYYY-mm-ddTHH:MM:SSZ" remains as ["YYYY-mm-ddTHH:MM:SSZ",
"YYYY-mm-ddTHH:MM:SSZ"]
- - A list of date-time ranges can be provided for multiple intervals.
+ - A list of date-time ranges can be provided for multiple
intervals.
Example: "2020-01-01T00:00:00Z" or python_datetime.datetime(2020,
1, 1) or [["2020-01-01T00:00:00Z", "2021-01-01T00:00:00Z"]]
:param max_items: The maximum number of items to return from the
search, even if there are more matching results.
