SedonaDB Documentation

SedonaDB's documentation is powered by mkdocs.org and mkdocs-material. To build the documentation locally, clone the repo, install the Python requirements, and use the mkdocs command-line tool to build or serve the documentation.

git clone https://github.com/apache/sedona-db.git && cd sedona-db

# OPTIONAL: build the doc for the latest dev version of sedona-db
pip install -e "python/sedonadb/[test]" -vv

pip install -r docs/requirements.txt
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.