Add inline example for sphdistance (GenericMappingTools#1916)

Co-authored-by: Wei Ji <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>

Author: 3 people

pygmt/src/sphdistance.py

@@ -13,6 +13,8 @@
 )
 from pygmt.io import load_dataarray
 
+__doctest_skip__ = ["sphdistance"]
+
 
 @fmt_docstring
 @use_alias(
@@ -99,6 +101,19 @@ def sphdistance(data=None, x=None, y=None, **kwargs):
         - :class:`xarray.DataArray` if ``outgrid`` is not set
         - None if ``outgrid`` is set (grid output will be stored in file set by
           ``outgrid``)
+
+    Example
+    -------
+    >>> import numpy as np
+    >>> import pygmt
+    >>> # Create an array of longitude/latitude coordinates
+    >>> coords_list = [[85.5, 22.3], [82.3, 22.6], [85.8, 22.4], [86.5, 23.3]]
+    >>> coords_array = np.array(coords_list)
+    >>> # Perform a calculation of the distance to
+    >>> # each point from Voronoi polygons
+    >>> grid = pygmt.sphdistance(
+    ...     data=coords_array, spacing=[1, 2], region=[82, 87, 22, 24]
+    ... )
     """
     if kwargs.get("I") is None or kwargs.get("R") is None:
         raise GMTInvalidInput("Both 'region' and 'spacing' must be specified.")