Google Git
Sign in
apache / sedona-db / refs/heads/branch-0.1.0 / . / docs
tree: 17bd25d6d4d08b685f78111030642f66820e8f2f [path history] [tgz]
  1. image/
  2. reference/
  3. stylesheets/
  4. contributors-guide.md
  5. crs-examples.ipynb
  6. crs-examples.md
  7. delta-lake.ipynb
  8. delta-lake.md
  9. geopandas-interop.ipynb
  10. geopandas-interop.md
  11. index.md
  12. overture-examples.ipynb
  13. overture-examples.md
  14. programming-guide.ipynb
  15. programming-guide.md
  16. quickstart-python.ipynb
  17. quickstart-python.md
  18. README.md
  19. requirements.txt
  20. sample_geometries.json
  21. working-with-parquet-files.ipynb
  22. working-with-parquet-files.md
  23. working-with-sql-sedonadb.md
docs/README.md

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.