Skip to content

Commit

Permalink
doc api ref: add missing functions + re-organize (#76)
Browse files Browse the repository at this point in the history
Rename and/or re-order sections.
  • Loading branch information
benbovy authored Nov 15, 2024
1 parent 780bb1f commit eb7d03f
Showing 1 changed file with 27 additions and 12 deletions.
39 changes: 27 additions & 12 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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

0 comments on commit eb7d03f

Please sign in to comment.