From eb7d03f2cc3d79386570a15671511d53d7a2467c Mon Sep 17 00:00:00 2001 From: Benoit Bovy Date: Fri, 15 Nov 2024 09:27:41 +0100 Subject: [PATCH] doc api ref: add missing functions + re-organize (#76) Rename and/or re-order sections. --- docs/api.rst | 39 +++++++++++++++++++++++++++------------ 1 file changed, 27 insertions(+), 12 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 5851fce..b5b7fa5 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -31,22 +31,33 @@ Geography creation multipoint multilinestring polygon - geography_collection + collection is_prepared prepare destroy_prepared -.. _api_accessors: +.. _api_io: -Geography accessors -------------------- +Input/Output +------------ .. autosummary:: :toctree: _api_generated/ - centroid - boundary - convex_hull + from_wkt + to_wkt + from_geoarrow + +.. _api_measurement: + +Measurement +----------- + +.. autosummary:: + :toctree: _api_generated/ + + area + distance .. _api_predicates: @@ -58,17 +69,21 @@ Predicates equals intersects + touches contains within disjoint + covers + covered_by +.. _api_constructive_ops: -Input/Output ------------- +Constructive operations +----------------------- .. autosummary:: :toctree: _api_generated/ - from_wkt - to_wkt - from_geoarrow + centroid + boundary + convex_hull