[DOCS] Move the binder notebooks to docs and enable notebook renderin…

…g in Sedona website (#1336) * Move the binder file location and enable notebook visualization * Fix linter
apache · Apr 14, 2024 · dc7e5c9 · dc7e5c9
1 parent 8324e2c
commit dc7e5c9
Show file tree

Hide file tree

Showing 58 changed files with 2,707 additions and 38 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -30,6 +30,7 @@ jobs:
     - uses: actions/setup-python@v5
       with:
         python-version: 3.x
+    - run: pip install mkdocs-jupyter
     - run: pip install mkdocs-material
     - run: pip install mkdocs-macros-plugin
     - run: pip install mkdocs-git-revision-date-localized-plugin

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -17,7 +17,7 @@ repos:
         name: Run codespell
         description: Check spelling with codespell
         args: [--ignore-words=.github/linters/codespell.txt]
-        exclude: ^docs/image|^spark/common/src/test/resources
+        exclude: ^docs/image|^spark/common/src/test/resources|^docs/usecases
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
     hooks:

diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ Some of the key features of Apache Sedona include:
 
 These are some of the key features of Apache Sedona, but it may offer additional capabilities depending on the specific version and configuration.
 
-Click [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/apache/sedona/HEAD?filepath=binder) and play the interactive Sedona Python Jupyter Notebook immediately!
+Click [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/apache/sedona/HEAD?filepath=docs/usecases) and play the interactive Sedona Python Jupyter Notebook immediately!
 
 ## When to use Sedona?
 

diff --git a/docker/sedona-spark-jupyterlab/sedona-jupyterlab.dockerfile b/docker/sedona-spark-jupyterlab/sedona-jupyterlab.dockerfile
@@ -51,9 +51,9 @@ RUN ${SEDONA_HOME}/docker/sedona.sh ${sedona_version} ${geotools_wrapper_version
 COPY docker/sedona-spark-jupyterlab/requirements.txt /opt/requirements.txt
 RUN pip3 install -r /opt/requirements.txt
 
-COPY binder/*.ipynb /opt/workspace/examples/
-COPY binder/*.py /opt/workspace/examples/
-COPY binder/data /opt/workspace/examples/data
+COPY docs/usecases/*.ipynb /opt/workspace/examples/
+COPY docs/usecases/*.py /opt/workspace/examples/
+COPY docs/usecases/data /opt/workspace/examples/data
 
 # Add the master IP address to all notebooks
 RUN find /opt/workspace/examples/ -type f -name "*.ipynb" -exec sed -i 's/config = SedonaContext.builder()/config = SedonaContext.builder().master(\\"spark:\/\/localhost:7077\\")/' {} +

diff --git a/docs/api/.gitignore b/docs/api/.gitignore
@@ -1,2 +1,3 @@
 /rdocs/
 /javadoc/
+/scaladoc/
diff --git a/docs/setup/compile.md b/docs/setup/compile.md
@@ -1,6 +1,6 @@
 # Compile Sedona source code
 
-[![Scala and Java build](https://github.com/apache/sedona/actions/workflows/java.yml/badge.svg)](https://github.com/apache/sedona/actions/workflows/java.yml) [![Python build](https://github.com/apache/sedona/actions/workflows/python.yml/badge.svg)](https://github.com/apache/sedona/actions/workflows/python.yml) [![R build](https://github.com/apache/sedona/actions/workflows/r.yml/badge.svg)](https://github.com/apache/sedona/actions/workflows/r.yml) [![Example project build](https://github.com/apache/sedona/actions/workflows/example.yml/badge.svg)](https://github.com/apache/sedona/actions/workflows/example.yml) [![Docs build](https://github.com/apache/sedona/actions/workflows/docs.yml/badge.svg)](https://github.com/apache/sedona/actions/workflows/docs.yml) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/apache/sedona/HEAD?filepath=binder)
+[![Scala and Java build](https://github.com/apache/sedona/actions/workflows/java.yml/badge.svg)](https://github.com/apache/sedona/actions/workflows/java.yml) [![Python build](https://github.com/apache/sedona/actions/workflows/python.yml/badge.svg)](https://github.com/apache/sedona/actions/workflows/python.yml) [![R build](https://github.com/apache/sedona/actions/workflows/r.yml/badge.svg)](https://github.com/apache/sedona/actions/workflows/r.yml) [![Example project build](https://github.com/apache/sedona/actions/workflows/example.yml/badge.svg)](https://github.com/apache/sedona/actions/workflows/example.yml) [![Docs build](https://github.com/apache/sedona/actions/workflows/docs.yml/badge.svg)](https://github.com/apache/sedona/actions/workflows/docs.yml) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/apache/sedona/HEAD?filepath=docs/usecases)
 
 ## Compile Scala / Java source code
 

diff --git a/docs/setup/install-python.md b/docs/setup/install-python.md
@@ -1,4 +1,4 @@
-Click [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/apache/sedona/HEAD?filepath=binder) and play the interactive Sedona Python Jupyter Notebook immediately!
+Click [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/apache/sedona/HEAD?filepath=docs/usecases) and play the interactive Sedona Python Jupyter Notebook immediately!
 
 Apache Sedona extends pyspark functions which depends on libraries:
 

diff --git a/docs/tutorial/jupyter-notebook.md b/docs/tutorial/jupyter-notebook.md
@@ -1,8 +1,8 @@
 # Python Jupyter Notebook Examples
 
-Click [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/apache/sedona/HEAD?filepath=binder) and play the interactive Sedona Python Jupyter Notebook immediately!
+Click [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/apache/sedona/HEAD?filepath=docs/usecases) and play the interactive Sedona Python Jupyter Notebook immediately!
 
-Sedona Python provides a number of [Jupyter Notebook examples](https://github.com/apache/sedona/blob/master/binder/).
+Sedona Python provides a number of [Jupyter Notebook examples](https://github.com/apache/sedona/blob/master/docs/usecases/).
 
 Please use the following steps to run Jupyter notebook with Pipenv on your machine
 
@@ -12,14 +12,14 @@ Please use the following steps to run Jupyter notebook with Pipenv on your machi
 4. Setup pipenv python version. Please use your desired Python version.
 
 ```bash
-cd binder
+cd docs/usecases
 pipenv --python 3.8
 ```
 
 5. Install dependencies
 
 ```bash
-cd binder
+cd docs/usecases
 pipenv install
 ```
 

diff --git a/docs/tutorial/raster.md b/docs/tutorial/raster.md
@@ -42,7 +42,7 @@ Detailed SedonaSQL APIs are available here: [SedonaSQL API](../api/sql/Overview.
 === "Python"
 
 	1. Please read [Quick start](../setup/install-python.md) to install Sedona Python.
-	2. This tutorial is based on [Sedona SQL Jupyter Notebook example](jupyter-notebook.md). You can interact with Sedona Python Jupyter Notebook immediately on Binder. Click [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/apache/sedona/HEAD?filepath=binder) to interact with Sedona Python Jupyter notebook immediately on Binder.
+	2. This tutorial is based on [Sedona SQL Jupyter Notebook example](jupyter-notebook.md). You can interact with Sedona Python Jupyter Notebook immediately on Binder. Click [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/apache/sedona/HEAD?filepath=docs/usecases) to interact with Sedona Python Jupyter notebook immediately on Binder.
 
 ## Create Sedona config
 

diff --git a/docs/tutorial/sql.md b/docs/tutorial/sql.md
@@ -39,7 +39,7 @@ Detailed SedonaSQL APIs are available here: [SedonaSQL API](../api/sql/Overview.
 === "Python"
 
 	1. Please read [Quick start](../setup/install-python.md) to install Sedona Python.
-	2. This tutorial is based on [Sedona SQL Jupyter Notebook example](jupyter-notebook.md). You can interact with Sedona Python Jupyter notebook immediately on Binder. Click [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/apache/sedona/HEAD?filepath=binder) to interact with Sedona Python Jupyter notebook immediately on Binder.
+	2. This tutorial is based on [Sedona SQL Jupyter Notebook example](jupyter-notebook.md). You can interact with Sedona Python Jupyter notebook immediately on Binder. Click [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/apache/sedona/HEAD?filepath=docs/usecases) to interact with Sedona Python Jupyter notebook immediately on Binder.
 
 ## Create Sedona config
 

diff --git a/binder/.gitignore → docs/usecases/.gitignore b/binder/.gitignore → docs/usecases/.gitignore
diff --git a/binder/ApacheSedonaCore.ipynb → docs/usecases/ApacheSedonaCore.ipynb b/binder/ApacheSedonaCore.ipynb → docs/usecases/ApacheSedonaCore.ipynb
diff --git a/binder/ApacheSedonaRaster.ipynb → docs/usecases/ApacheSedonaRaster.ipynb b/binder/ApacheSedonaRaster.ipynb → docs/usecases/ApacheSedonaRaster.ipynb
diff --git a/binder/ApacheSedonaSQL.ipynb → docs/usecases/ApacheSedonaSQL.ipynb b/binder/ApacheSedonaSQL.ipynb → docs/usecases/ApacheSedonaSQL.ipynb
diff --git a/...aSQL_SpatialJoin_AirportsPerCountry.ipynb → ...aSQL_SpatialJoin_AirportsPerCountry.ipynb b/...aSQL_SpatialJoin_AirportsPerCountry.ipynb → ...aSQL_SpatialJoin_AirportsPerCountry.ipynb
diff --git a/binder/Pipfile → docs/usecases/Pipfile b/binder/Pipfile → docs/usecases/Pipfile
diff --git a/binder/Sedona_OvertureMaps_GeoParquet.ipynb → ...ases/Sedona_OvertureMaps_GeoParquet.ipynb b/binder/Sedona_OvertureMaps_GeoParquet.ipynb → ...ases/Sedona_OvertureMaps_GeoParquet.ipynb
@@ -1,5 +1,15 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "66a56fcb-27a5-4b37-a913-05a8f887d22f",
+   "metadata": {
+    "tags": []
+   },
+   "source": [
+    "# Understand Overture Map data"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,
@@ -16,22 +26,12 @@
     "import geopandas as gpd"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "66a56fcb-27a5-4b37-a913-05a8f887d22f",
-   "metadata": {
-    "tags": []
-   },
-   "source": [
-    "# Overture Map data"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "3cfd484a-e6ac-4cdb-a8ac-2ed77fbd23db",
    "metadata": {},
    "source": [
-    "## Wherobots version\n",
+    "### Wherobots version\n",
     "\n",
     "Wherobots only releases a version for overturemaps-us-west-2/release/2023-07-26-alpha.0/.\n",
     "\n",
@@ -55,7 +55,7 @@
    "id": "b5fcf043-a97d-4321-ac16-fafcdbbcf3aa",
    "metadata": {},
    "source": [
-    "## OMF versions\n",
+    "### OMF versions\n",
     "\n",
     "The following files are official OMF releases. They are GeoParquet files generated by Apache Sedona.\n",
     "\n",
@@ -83,7 +83,7 @@
     "tags": []
    },
    "source": [
-    "# Create Sedona Context"
+    "## Create Sedona Context"
    ]
   },
   {
@@ -207,16 +207,17 @@
    "id": "8f3340ee",
    "metadata": {},
    "source": [
-    "# Spatial filter by boundary"
+    "## Spatial filter by boundary"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "8b1b506c",
    "metadata": {},
    "source": [
-    "### Pick a boundary.\n",
-    "#### Bellevue city is selected\n",
+    "### Pick a boundary\n",
+    "\n",
+    "Bellevue city is selected\n",
     "\n",
     "[Click here for boundaries of other states](https://gist.github.com/JoshuaCarroll/49630cbeeb254a49986e939a26672e9c)"
    ]
@@ -275,7 +276,7 @@
    "id": "9d2cd7e5",
    "metadata": {},
    "source": [
-    "# Place Dataset "
+    "## Place Dataset "
    ]
   },
   {
@@ -836,7 +837,7 @@
     "tags": []
    },
    "source": [
-    "# Building Dataset "
+    "## Building Dataset "
    ]
   },
   {
@@ -940,7 +941,7 @@
    "id": "c0809afb",
    "metadata": {},
    "source": [
-    "# Admins Theme Datasets"
+    "## Admins Theme Datasets"
    ]
   },
   {
@@ -1140,7 +1141,7 @@
    "id": "328ffd56",
    "metadata": {},
    "source": [
-    "# Transportation Theme Datasets"
+    "## Transportation Theme Datasets"
    ]
   },
   {

diff --git a/binder/apt.txt → docs/usecases/apt.txt b/binder/apt.txt → docs/usecases/apt.txt
diff --git a/binder/contrib/ApacheSedonaImageFilter.ipynb → ...ses/contrib/ApacheSedonaImageFilter.ipynb b/binder/contrib/ApacheSedonaImageFilter.ipynb → ...ses/contrib/ApacheSedonaImageFilter.ipynb
diff --git a/binder/contrib/DownloadImageFromGEE.ipynb → ...ecases/contrib/DownloadImageFromGEE.ipynb b/binder/contrib/DownloadImageFromGEE.ipynb → ...ecases/contrib/DownloadImageFromGEE.ipynb
diff --git a/...er/contrib/NdviSentinelApacheSedona.ipynb → ...es/contrib/NdviSentinelApacheSedona.ipynb b/...er/contrib/NdviSentinelApacheSedona.ipynb → ...es/contrib/NdviSentinelApacheSedona.ipynb
diff --git a/...ib/PostgresqlConnectionApacheSedona.ipynb → ...ib/PostgresqlConnectionApacheSedona.ipynb b/...ib/PostgresqlConnectionApacheSedona.ipynb → ...ib/PostgresqlConnectionApacheSedona.ipynb
diff --git a/.../contrib/VectorAnalisisApacheSedona.ipynb → .../contrib/VectorAnalisisApacheSedona.ipynb b/.../contrib/VectorAnalisisApacheSedona.ipynb → .../contrib/VectorAnalisisApacheSedona.ipynb