Remote datasets: Include images of the official documentation in API reference (#2728)

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Author: yvonnefroehlich

pygmt/datasets/earth_age.py

@@ -15,6 +15,12 @@ def load_earth_age(resolution="01d", region=None, registration=None):
     r"""
     Load the Earth seafloor crustal age dataset in various resolutions.
 
+    .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_age.png # noqa: W505
+       :width: 80 %
+       :align: center
+
+       Earth seafloor crustal age dataset.
+
     The grids are downloaded to a user data directory
     (usually ``~/.gmt/server/earth/earth_age/``) the first time you invoke
     this function. Afterwards, it will load the grid from the data directory.

pygmt/datasets/earth_free_air_anomaly.py

@@ -16,6 +16,12 @@ def load_earth_free_air_anomaly(resolution="01d", region=None, registration=None
     Load the IGPP Global Earth Free-Air Anomaly datatset in various
     resolutions.
 
+    .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_faa.jpg # noqa: W505
+       :width: 80 %
+       :align: center
+
+       IGPP Global Earth Free-Air Anomaly datatset.
+
     The grids are downloaded to a user data directory
     (usually ``~/.gmt/server/earth/earth_faa/``) the first time you invoke
     this function. Afterwards, it will load the grid from the data directory.

pygmt/datasets/earth_geoid.py

@@ -15,6 +15,12 @@ def load_earth_geoid(resolution="01d", region=None, registration=None):
     r"""
     Load the EGM2008 Global Earth Geoid dataset in various resolutions.
 
+    .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_geoid.jpg # noqa: W505
+       :width: 80 %
+       :align: center
+
+       EGM2008 Global Earth Geoid dataset.
+
     The grids are downloaded to a user data directory
     (usually ``~/.gmt/server/earth/earth_geoid/``) the first time you invoke
     this function. Afterwards, it will load the grid from the data directory.

pygmt/datasets/earth_magnetic_anomaly.py

@@ -18,6 +18,15 @@ def load_earth_magnetic_anomaly(
     r"""
     Load the Earth magnetic anomaly datasets in various resolutions.
 
+    .. list-table::
+       :widths: 50 50
+       :header-rows: 1
+
+       * - Global Earth Magnetic Anomaly Model (EMAG2)
+         - World Digital Magnetic Anomaly Map (WDMAM)
+       * - .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_mag.jpg # noqa: W505
+         - .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_wdmam.jpg # noqa: W505
+
     The grids are downloaded to a user data directory
     (usually ``~/.gmt/server/earth/earth_mag/``,
     ``~/.gmt/server/earth/earth_mag4km/``,

pygmt/datasets/earth_mask.py

@@ -15,6 +15,12 @@ def load_earth_mask(resolution="01d", region=None, registration=None):
     r"""
     Load the GSHHG Global Earth Mask dataset in various resolutions.
 
+    .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_earthmask.png # noqa: W505
+       :width: 80 %
+       :align: center
+
+       GSHHG Global Earth Mask dataset.
+
     The grids are downloaded to a user data directory
     (usually ``~/.gmt/server/earth/earth_mask/``) the first time you invoke
     this function. Afterwards, it will load the grid from the data directory.

pygmt/datasets/earth_relief.py

@@ -23,6 +23,12 @@ def load_earth_relief(
     Load the Earth relief datasets (topography and bathymetry) in various
     resolutions.
 
+    .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_gebcosi.jpg # noqa: W505
+       :width: 80 %
+       :align: center
+
+       Earth relief datasets (topography and bathymetry).
+
     The grids are downloaded to a user data directory
     (usually ``~/.gmt/server/earth/earth_relief``,
     ``~/.gmt/server/earth/earth_gebco``, ``~/.gmt/server/earth/earth_gebcosi``,

pygmt/datasets/earth_vertical_gravity_gradient.py

@@ -18,6 +18,12 @@ def load_earth_vertical_gravity_gradient(
     Load the IGPP Global Earth Vertical Gravity Gradient dataset in various
     resolutions.
 
+    .. figure:: https://www.generic-mapping-tools.org/remote-datasets/_images/GMT_vgg.jpg # noqa: W505
+       :width: 80 %
+       :align: center
+
+       IGPP Global Earth Vertical Gravity Gradient dataset.
+
     The grids are downloaded to a user data directory
     (usually ``~/.gmt/server/earth/earth_vgg/``) the first time you invoke
     this function. Afterwards, it will load the grid from the data directory.