This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/sedona-spatialbench.git
The following commit(s) were added to refs/heads/main by this push:
new 04c3241 [DOCS] Add GitHub CI to deploy docs to asf-site (#14)
04c3241 is described below
commit 04c3241250a1442fdf64955f4571205a9040dfd8
Author: Jia Yu <[email protected]>
AuthorDate: Wed Sep 17 18:19:38 2025 -0700
[DOCS] Add GitHub CI to deploy docs to asf-site (#14)
* Fix
Add
Fix the CI
* Fix everything
---
.github/workflows/packaging.yml | 108 ++++++++++++++++++
.gitignore | 3 +-
docs-overrides/placeholder.txt => .gitkeep | 0
{docs-overrides => docs/image}/sedona_logo.png | Bin
.../image}/sedona_logo_symbol.png | Bin
.../image}/sedona_logo_symbol.svg | 0
docs/requirements.txt | 9 ++
mkdocs.yml | 123 +++++++++++++--------
8 files changed, 198 insertions(+), 45 deletions(-)
diff --git a/.github/workflows/packaging.yml b/.github/workflows/packaging.yml
new file mode 100644
index 0000000..507ba95
--- /dev/null
+++ b/.github/workflows/packaging.yml
@@ -0,0 +1,108 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+name: Build and Deploy Docs
+
+on:
+ push:
+ branches:
+ - main
+ pull_request:
+ branches:
+ - main
+
+permissions:
+ contents: write
+
+concurrency:
+ group: ${{ github.repository }}-${{ github.ref }}-${{ github.workflow }}
+ cancel-in-progress: true
+
+jobs:
+ build-docs:
+ name: Build Documentation
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+
+ - uses: actions/setup-python@v5
+ with:
+ python-version: "3.x"
+
+ - name: Install docs requirements
+ run: pip install -r docs/requirements.txt
+
+ - name: Build documentation
+ # Using mkdocs build is the standard way to generate the site
+ run: mkdocs build --strict
+
+ - name: Compress docs for artifact upload
+ run: |
+ # The update-asf-site job expects a specific folder name inside the
tarball
+ cp -R site documentation-site
+ tar -czf docs.tgz documentation-site
+
+ - name: Upload docs artifact
+ uses: actions/upload-artifact@v4
+ with:
+ name: docs
+ retention-days: 2
+ path: docs.tgz
+
+ update-asf-site:
+ name: Deploy Dev Snapshot
+ runs-on: ubuntu-latest
+ needs:
+ - build-docs
+ # This job should only run on pushes to the main branch
+ if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+
+ steps:
+ - uses: actions/download-artifact@v4
+ with:
+ name: docs
+
+ - name: Clone asf-site branch
+ uses: actions/checkout@v4
+ with:
+ ref: asf-site
+ path: pages-clone
+
+ - name: Update development documentation
+ run: |
+ git config --global user.email "[email protected]"
+ git config --global user.name "GitHub Actions"
+
+ cd pages-clone
+ # Remove all existing content except .git directory
+ find . -maxdepth 1 -not -name '.git' -not -name '.' -exec rm -rf {} +
+
+ tar -xf ../docs.tgz
+ # Move all content from documentation-site to root of asf-site branch
+ mv documentation-site/* .
+ mv documentation-site/.* . 2>/dev/null || true
+ rmdir documentation-site
+
+ git add *
+ git commit --allow-empty -m"update documentation for main branch"
+
+ - name: Push development documentation to asf-site
+ # Ensure this push only happens on the intended repository
+ if: success() && github.repository == 'apache/sedona-spatialbench'
+ run: |
+ cd pages-clone
+ git push
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index ef36049..0041ccf 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,4 +3,5 @@ target/
__old/
Cargo.lock
.idea
-.venv/
\ No newline at end of file
+.venv/
+site/
\ No newline at end of file
diff --git a/docs-overrides/placeholder.txt b/.gitkeep
similarity index 100%
rename from docs-overrides/placeholder.txt
rename to .gitkeep
diff --git a/docs-overrides/sedona_logo.png b/docs/image/sedona_logo.png
similarity index 100%
rename from docs-overrides/sedona_logo.png
rename to docs/image/sedona_logo.png
diff --git a/docs-overrides/sedona_logo_symbol.png
b/docs/image/sedona_logo_symbol.png
similarity index 100%
rename from docs-overrides/sedona_logo_symbol.png
rename to docs/image/sedona_logo_symbol.png
diff --git a/docs-overrides/sedona_logo_symbol.svg
b/docs/image/sedona_logo_symbol.svg
similarity index 100%
rename from docs-overrides/sedona_logo_symbol.svg
rename to docs/image/sedona_logo_symbol.svg
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..500f80c
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,9 @@
+mike
+mkdocs-git-revision-date-localized-plugin
+mkdocs-glightbox
+mkdocs-macros-plugin
+mkdocs-material
+mkdocstrings[python]
+nbconvert
+pyproj
+ruff
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index dd33807..4f6aa68 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -16,28 +16,31 @@
# under the License.
site_name: Apache Sedona SpatialBench
-site_description: SpatialBench is a high-performance geospatial benchmark for
generating synthetic spatial data at scale.
+site_description: SpatialBench is a benchmark for assessing geospatial SQL
analytics query performance across database systems
nav:
- SpatialBench: index.md
- Overview and Methodology: overview-methodology.md
- Blog: "https://sedona.apache.org/latest/blog/";
- Community: "https://sedona.apache.org/latest/community/contact/";
- Apache Software Foundation: "https://sedona.apache.org/latest/asf/asf/";
- - Sedona Homepage: "https://sedona.apache.org/latest/";
- - SedonaDB Homepage: "https://sedona.apache.org/sedonadb/";
+ - Return toSedona Homepage: "https://sedona.apache.org/latest/";
repo_url: https://github.com/apache/sedona-spatialbench/
+edit_uri: https://github.com/apache/sedona-spatialbench/blob/main/docs/
repo_name: apache/sedona-spatialbench
theme:
- font: false
- name: 'material'
- custom_dir: docs-overrides
+ name: material
+ font:
+ font: false
+ name: 'material'
palette:
primary: custom
accent: 'green'
+ favicon: image/sedona_logo_symbol.png
+ logo: image/sedona_logo_symbol.svg
icon:
- logo: sedona_logo_symbol
+ logo: fontawesome/solid/earth-americas
repo: fontawesome/brands/github
features:
- content.code.copy
@@ -52,10 +55,6 @@ theme:
- navigation.tabs
- navigation.tabs.sticky
extra:
- version:
- provider: mike
- default:
- - latest
social:
- icon: fontawesome/brands/github
link: 'https://github.com/apache/spatialbench'
@@ -73,39 +72,75 @@ extra_javascript:
copyright: Copyright © 2025 The Apache Software Foundation. Apache Sedona,
Sedona, Apache, the Apache feather logo, and the Apache Sedona project logo are
either registered trademarks or trademarks of The Apache Software Foundation in
the United States and other countries. All other marks mentioned may be
trademarks or registered trademarks of their respective owners. Please visit <a
href="https://www.apache.org/";>Apache Software Foundation</a> for more
details.<img referrerpolicy="no-re [...]
markdown_extensions:
- - admonition
- - attr_list
- - codehilite
- - toc:
- permalink: true
- toc_depth: 3
- - pymdownx.arithmatex
- - pymdownx.betterem:
- smart_enable: all
- - pymdownx.caret
- - pymdownx.critic
- - pymdownx.details
- - pymdownx.emoji:
- emoji_generator: !!python/name:pymdownx.emoji.to_svg
- - pymdownx.inlinehilite
- - pymdownx.magiclink
- - pymdownx.mark
- - pymdownx.smartsymbols
- - pymdownx.superfences:
- custom_fences:
+ - admonition
+ - attr_list
+ - codehilite
+ - footnotes
+ - toc:
+ permalink: true
+ toc_depth: 3
+ - pymdownx.arithmatex
+ - pymdownx.betterem:
+ smart_enable: all
+ - pymdownx.caret
+ - pymdownx.critic
+ - pymdownx.details
+ - pymdownx.emoji
+ - pymdownx.highlight
+ - pymdownx.inlinehilite
+ - pymdownx.magiclink
+ - pymdownx.mark
+ - pymdownx.smartsymbols
+ - pymdownx.snippets:
+ base_path: ["docs/"]
+ - pymdownx.superfences:
+ custom_fences:
- name: mermaid
class: mermaid
- format: !!python/name:pymdownx.superfences.fence_code_format
- - pymdownx.tabbed:
- alternate_style: true
- - pymdownx.tasklist:
- custom_checkbox: true
- - pymdownx.tilde
+ - pymdownx.tabbed:
+ alternate_style: true
+ - pymdownx.tasklist:
+ custom_checkbox: true
+ - pymdownx.tilde
plugins:
- - search:
- # prebuild_index: true
- - macros
- - git-revision-date-localized:
- type: datetime
- - mike:
- canonical_version: 'latest'
+ - search
+ - macros
+ - git-revision-date-localized:
+ type: datetime
+ - glightbox:
+ touchNavigation: true
+ loop: false
+ effect: zoom
+ slide_effect: slide
+ width: 100%
+ height: auto
+ zoomable: true
+ draggable: true
+ skip_classes:
+ - custom-skip-class-name
+ - skip-lightbox
+ auto_caption: false
+ caption_position: bottom
+ background: white
+ shadow: false
+ manual: false
+ - tags
+ - mkdocstrings:
+ handlers:
+ python:
+ inventories:
+ - https://docs.python.org/3/objects.inv
+ - https://geopandas.org/en/stable/objects.inv
+ - https://pandas.pydata.org/docs/objects.inv
+ options:
+ docstring_section_style: list
+ docstring_style: google
+ line_length: 80
+ separate_signature: true
+ show_root_heading: true
+ show_signature_annotations: true
+ show_source: false
+ show_symbol_type_toc: true
+ signature_crossrefs: true
+ extra:
+ paths: ['python']
\ No newline at end of file
