This is an automated email from the ASF dual-hosted git repository. jiayu pushed a commit to branch gh-pages in repository https://gitbox.apache.org/repos/asf/incubator-sedona.git
commit 518cb5b9040e94a302f917f94d03a2ab5db414b3 Author: Jia Yu <[email protected]> AuthorDate: Thu Dec 22 23:35:46 2022 -0700 Deployed f6cd274f to 1.3.1-incubating with MkDocs 1.4.2 and mike 1.1.2 --- 1.3.1-incubating/.DS_Store | Bin 14340 -> 14340 bytes 1.3.1-incubating/api/flink/Function/index.html | 32 +++++++++- 1.3.1-incubating/api/sql/Function/index.html | 29 ++++++++- 1.3.1-incubating/api/sql/Parameter/index.html | 9 ++- 1.3.1-incubating/community/publish/index.html | 78 +++++++++++++++++++------ 1.3.1-incubating/search/search_index.json | 2 +- 1.3.1-incubating/setup/compile/index.html | 5 +- 1.3.1-incubating/sitemap.xml.gz | Bin 251 -> 251 bytes 8 files changed, 131 insertions(+), 24 deletions(-) diff --git a/1.3.1-incubating/.DS_Store b/1.3.1-incubating/.DS_Store index 3753f117..311c9ff3 100644 Binary files a/1.3.1-incubating/.DS_Store and b/1.3.1-incubating/.DS_Store differ diff --git a/1.3.1-incubating/api/flink/Function/index.html b/1.3.1-incubating/api/flink/Function/index.html index 12996c66..88591123 100644 --- a/1.3.1-incubating/api/flink/Function/index.html +++ b/1.3.1-incubating/api/flink/Function/index.html @@ -2029,6 +2029,15 @@ </a> +</li> + + <li class="md-nav__item"> + + <a href="#st_concavehull" class="md-nav__link"> + ST_ConcaveHull + </a> + + </li> <li class="md-nav__item"> @@ -3593,6 +3602,15 @@ </a> +</li> + + <li class="md-nav__item"> + + <a href="#st_concavehull" class="md-nav__link"> + ST_ConcaveHull + </a> + + </li> <li class="md-nav__item"> @@ -4086,6 +4104,18 @@ If the geometry is lacking SRID a WKT format is produced. <p>Input: <code>MULTILINESTRING((0 0, 10 0, 10 10, 0 10, 0 0),(10 10, 20 10, 20 20, 10 20, 10 10))</code></p> <p>Output: <code>MULTIPOLYGON(((0 0,0 10,10 10,10 0,0 0)),((10 10,10 20,20 20,20 10,10 10)))</code></p> +<h2 id="st_concavehull">ST_ConcaveHull<a class="headerlink" href="#st_concavehull" title="Permanent link">¶</a></h2> +<p>Introduction: Return the Concave Hull of polgyon A, with alpha set to pctConvex[0, 1] in the Delaunay Triangulation method, the concave hull will not contain a hole unless allowHoles is set to true</p> +<p>Format: <code>ST_ConcaveHull (A:geometry, pctConvex:float)</code></p> +<p>Format: <code>ST_ConcaveHull (A:geometry, pctConvex:float, allowHoles:Boolean)</code></p> +<p>Since: <code>v1.3.2</code></p> +<p>Example:</p> +<div class="highlight"><pre><span></span><code><span class="k">SELECT</span><span class="w"> </span><span class="n">ST_ConcaveHull</span><span class="p">(</span><span class="n">polygondf</span><span class="p">.</span><span class="n">countyshape</span><span class="p">,</span><span class="w"> </span><span class="n">pctConvex</span><span class="p">)</span><span class="o">`</span><span class="w"></span> +<span class="k">FROM</span><span class="w"> </span><span class="n">polygondf</span><span class="w"></span> +</code></pre></div> + +<p>Input: <code>Polygon ((0 0, 1 2, 2 2, 3 2, 5 0, 4 0, 3 1, 2 1, 1 0, 0 0))</code></p> +<p>Output: <code>POLYGON ((1 2, 2 2, 3 2, 5 0, 4 0, 1 0, 0 0, 1 2))</code></p> <h2 id="st_distance">ST_Distance<a class="headerlink" href="#st_distance" title="Permanent link">¶</a></h2> <p>Introduction: Return the Euclidean distance between A and B</p> <p>Format: <code>ST_Distance (A:geometry, B:geometry)</code></p> @@ -4491,7 +4521,7 @@ For SourceCRS and TargetCRS, WKT format is also available since v1.3.1.</p> <small> Last update: - <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-datetime">December 3, 2022 19:27:54</span> + <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-datetime">December 22, 2022 07:16:10</span> </small> diff --git a/1.3.1-incubating/api/sql/Function/index.html b/1.3.1-incubating/api/sql/Function/index.html index 13722a30..9a83537d 100644 --- a/1.3.1-incubating/api/sql/Function/index.html +++ b/1.3.1-incubating/api/sql/Function/index.html @@ -1690,6 +1690,15 @@ </a> +</li> + + <li class="md-nav__item"> + + <a href="#st_concavehull" class="md-nav__link"> + ST_ConcaveHull + </a> + + </li> <li class="md-nav__item"> @@ -3847,6 +3856,15 @@ </a> +</li> + + <li class="md-nav__item"> + + <a href="#st_concavehull" class="md-nav__link"> + ST_ConcaveHull + </a> + + </li> <li class="md-nav__item"> @@ -4614,6 +4632,15 @@ If the geometry is lacking SRID a WKT format is produced. +----------------------------------------------------------------------------+ </code></pre></div> +<h2 id="st_concavehull">ST_ConcaveHull<a class="headerlink" href="#st_concavehull" title="Permanent link">¶</a></h2> +<p>Introduction: Return the Concave Hull of polgyon A, with alpha set to pctConvex[0, 1] in the Delaunay Triangulation method, the concave hull will not contain a hole unless allowHoles is set to true</p> +<p>Format: <code>ST_ConcaveHull (A:geometry, pctConvex:float)</code></p> +<p>Format: <code>ST_ConcaveHull (A:geometry, pctConvex:float, allowHoles:Boolean)</code></p> +<p>Since: <code>v1.3.2</code></p> +<p>Spark SQL example: +<div class="highlight"><pre><span></span><code><span class="k">SELECT</span><span class="w"> </span><span class="n">ST_ConcaveHull</span><span class="p">(</span><span class="n">polygondf</span><span class="p">.</span><span class="n">countyshape</span><span class="p">,</span><span class="w"> </span><span class="n">pctConvex</span><span class="p">)</span><span class="o">`</span><span class="w"></span> +<span class="k">FROM</span><span class="w"> </span><span class="n">polygondf</span><span class="w"></span> +</code></pre></div></p> <h2 id="st_convexhull">ST_ConvexHull<a class="headerlink" href="#st_convexhull" title="Permanent link">¶</a></h2> <p>Introduction: Return the Convex Hull of polgyon A</p> <p>Format: <code>ST_ConvexHull (A:geometry)</code></p> @@ -5353,7 +5380,7 @@ For SourceCRS and TargetCRS, WKT format is also available since v1.3.1.</p> <small> Last update: - <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-datetime">December 3, 2022 19:27:54</span> + <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-datetime">December 22, 2022 07:16:10</span> </small> diff --git a/1.3.1-incubating/api/sql/Parameter/index.html b/1.3.1-incubating/api/sql/Parameter/index.html index e52ebf4b..f101131a 100644 --- a/1.3.1-incubating/api/sql/Parameter/index.html +++ b/1.3.1-incubating/api/sql/Parameter/index.html @@ -3102,6 +3102,13 @@ <li>Possible values: rtree, quadtree</li> </ul> </li> +<li>sedona.join.autoBroadcastJoinThreshold<ul> +<li>Configures the maximum size in bytes for a table that will be broadcast to all worker nodes when performing a join. + By setting this value to -1 automatic broadcasting can be disabled.</li> +<li>Default: The default value is the same as spark.sql.autoBroadcastJoinThreshold</li> +<li>Possible values: any integer with a byte suffix i.e. 10MB or 512KB</li> +</ul> +</li> <li>sedona.join.gridtype<ul> <li>Spatial partitioning grid type for join query</li> <li>Default: kdbtree</li> @@ -3133,7 +3140,7 @@ <small> Last update: - <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-datetime">December 3, 2022 01:46:53</span> + <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-datetime">December 13, 2022 08:33:57</span> </small> diff --git a/1.3.1-incubating/community/publish/index.html b/1.3.1-incubating/community/publish/index.html index f5b7a543..2982d820 100644 --- a/1.3.1-incubating/community/publish/index.html +++ b/1.3.1-incubating/community/publish/index.html @@ -2341,8 +2341,17 @@ <li class="md-nav__item"> - <a href="#javadoc-and-scaladoc" class="md-nav__link"> - Javadoc and Scaladoc + <a href="#prepare-the-environment-and-doc-folder" class="md-nav__link"> + Prepare the environment and doc folder + </a> + + +</li> + + <li class="md-nav__item"> + + <a href="#generate-javadoc-and-scaladoc" class="md-nav__link"> + Generate Javadoc and Scaladoc </a> @@ -2355,6 +2364,15 @@ </a> +</li> + + <li class="md-nav__item"> + + <a href="#deploy-the-website" class="md-nav__link"> + Deploy the website + </a> + + </li> </ul> @@ -3437,8 +3455,17 @@ <li class="md-nav__item"> - <a href="#javadoc-and-scaladoc" class="md-nav__link"> - Javadoc and Scaladoc + <a href="#prepare-the-environment-and-doc-folder" class="md-nav__link"> + Prepare the environment and doc folder + </a> + + +</li> + + <li class="md-nav__item"> + + <a href="#generate-javadoc-and-scaladoc" class="md-nav__link"> + Generate Javadoc and Scaladoc </a> @@ -3451,6 +3478,15 @@ </a> +</li> + + <li class="md-nav__item"> + + <a href="#deploy-the-website" class="md-nav__link"> + Deploy the website + </a> + + </li> </ul> @@ -3908,25 +3944,19 @@ R CMD check --as-cran apache.sedona_*.tar.gz <p>Then submit to CRAN using this <a href="https://xmpalantir.wu.ac.at/cransubmit/";>web form</a>.</p> <h2 id="11-publish-the-doc-website">11. Publish the doc website<a class="headerlink" href="#11-publish-the-doc-website" title="Permanent link">¶</a></h2> +<h3 id="prepare-the-environment-and-doc-folder">Prepare the environment and doc folder<a class="headerlink" href="#prepare-the-environment-and-doc-folder" title="Permanent link">¶</a></h3> <ol> -<li>Add the download link to <a href="/download#versions">Download page</a> and create a GitHub release.</li> -<li>Run <code>mkdocs build</code> in Sedona root directory. Copy all content in the <code>site</code> folder.</li> -<li>Check out GitHub incubator-sedona-website <a href="https://github.com/apache/incubator-sedona-website/tree/asf-site";>asf-site branch</a></li> -<li>Use the copied content to replace all content in <code>asf-site</code> branch and upload to GitHub. Then <code>sedona.apache.org</code> will be automatically updated.</li> -<li>You can also push the content to <code>asf-staging</code> branch. The staging website will be then updated: <code>sedona.staged.apache.org</code></li> +<li>Check out the 1.3.1-incubating Git tag on your local repo.</li> +<li>Read <a href="/setup/compile/#compile-the-documentation">Compile documentation website</a> to set up your environment. But don't deploy anything yet.</li> +<li>Add the download link to <a href="/download#versions">Download page</a>.</li> +<li>Add the news to <code>docs/index.md</code>.</li> </ol> -<h3 id="javadoc-and-scaladoc">Javadoc and Scaladoc<a class="headerlink" href="#javadoc-and-scaladoc" title="Permanent link">¶</a></h3> -<h4>Compile</h4> -<p>You should first compile the entire docs using <code>mkdocs build</code> to get the <code>site</code> folder.</p> +<h3 id="generate-javadoc-and-scaladoc">Generate Javadoc and Scaladoc<a class="headerlink" href="#generate-javadoc-and-scaladoc" title="Permanent link">¶</a></h3> <ul> -<li>Javadoc: Use Intelij IDEA to generate Javadoc for <code>core</code> and <code>viz</code> module</li> -<li>Scaladoc: Run <code>scaladoc -d site/api/javadoc/sql/ sql/src/main/scala/org/apache/sedona/sql/utils/*.scala</code></li> +<li>Javadoc: Use Intelij IDEA to generate Javadoc for <code>core</code> and <code>viz</code> module, output them to <code>docs/api/javadoc</code></li> +<li>Scaladoc: Run <code>scaladoc -d docs/api/javadoc/sql/ sql/src/main/scala/org/apache/sedona/sql/utils/*.scala</code></li> </ul> -<h4>Copy</h4> -<ol> -<li>Copy the generated Javadoc (Scaladoc should already be there) to the corresponding folders in <code>site/api/javadoc</code></li> -<li>Deploy Javadoc and Scaladoc with the project website</li> -</ol> +<p>Please do not commit these generated docs to Sedona GitHub.</p> <h3 id="compile-r-html-docs">Compile R html docs<a class="headerlink" href="#compile-r-html-docs" title="Permanent link">¶</a></h3> <ol> <li>Make sure you install R, tree and curl on your Ubuntu machine. On Mac, just do <code>brew install tree</code> @@ -3937,6 +3967,16 @@ R CMD check --as-cran apache.sedona_*.tar.gz Rscript generate-docs.R <span class="nb">cd</span> ./docs/api/rdocs <span class="o">&&</span> tree -H <span class="s1">'.'</span> -L <span class="m">1</span> --noreport --charset utf-8 -o index.html <span class="o">&&</span> <span class="nb">cd</span> ../../../ </code></pre></div></li> +</ol> +<h3 id="deploy-the-website">Deploy the website<a class="headerlink" href="#deploy-the-website" title="Permanent link">¶</a></h3> +<ol> +<li>Run <code>mike deploy --push --update-aliases 1.3.1-incubating latest</code>. This will deploy this website to Sedona main repo's gh-page. But Sedona does not use gh-page for hosting website.</li> +<li>Check out the master branch.</li> +<li>Git commit and push your changes in <code>download.md</code> and <code>index.md</code> to master branch. Delete all generated docs.</li> +<li>Check out the <code>gh-page</code> branch.</li> +<li>In a separate folder, check out GitHub sedona-website <a href="https://github.com/apache/incubator-sedona-website/tree/asf-site";>asf-site branch</a></li> +<li>Copy all content to in Sedona main repo <code>gh-page</code> branch to Sedona website repo <code>asf-site</code> branch.</li> +<li>Commit and push the changes to the remote <code>asf-site</code> branch.</li> </ol> <hr> diff --git a/1.3.1-incubating/search/search_index.json b/1.3.1-incubating/search/search_index.json index a7fa1fa6..ea87ae7f 100644 --- a/1.3.1-incubating/search/search_index.json +++ b/1.3.1-incubating/search/search_index.json @@ -1 +1 @@ -{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":true,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"12/01/2022: Sedona 1.3.0-incubating is released. It adds native support of GeoParquet, DataFrame style API, Scala 2.13, Python 3.10, spatial aggregation on Flink. Please check Sedona release notes. \u00b6 08/30/2022: Sedona 1.2.1-incubating is released. It supports Spark 2.4 - 3.3. and Flink 1.12+. \u00b6 04/16/2022: Sedona 1.2.0-incubating is rel [...] \ No newline at end of file +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":true,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"12/01/2022: Sedona 1.3.0-incubating is released. It adds native support of GeoParquet, DataFrame style API, Scala 2.13, Python 3.10, spatial aggregation on Flink. Please check Sedona release notes. \u00b6 08/30/2022: Sedona 1.2.1-incubating is released. It supports Spark 2.4 - 3.3. and Flink 1.12+. \u00b6 04/16/2022: Sedona 1.2.0-incubating is rel [...] \ No newline at end of file diff --git a/1.3.1-incubating/setup/compile/index.html b/1.3.1-incubating/setup/compile/index.html index 69f1706e..090dfa4b 100644 --- a/1.3.1-incubating/setup/compile/index.html +++ b/1.3.1-incubating/setup/compile/index.html @@ -3260,10 +3260,13 @@ pipenv run pytest tests pip install mkdocs-material pip install mkdocs-macros-plugin pip install mkdocs-git-revision-date-localized-plugin +pip install mike </code></pre></div> <p>After installing MkDocs and MkDocs-Material, run the command in Sedona root folder:</p> -<div class="highlight"><pre><span></span><code>mkdocs serve +<div class="highlight"><pre><span></span><code>mike deploy --update-aliases current-snapshot latest +mike set-default latest +mike serve </code></pre></div> <hr> diff --git a/1.3.1-incubating/sitemap.xml.gz b/1.3.1-incubating/sitemap.xml.gz index fe8acaa9..e112c84b 100644 Binary files a/1.3.1-incubating/sitemap.xml.gz and b/1.3.1-incubating/sitemap.xml.gz differ
