Update docs for enums

GenericMappingTools · Sep 27, 2024 · ac6239f · ac6239f
1 parent 7317b1b
commit ac6239f
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 27 deletions.
diff --git a/doc/_templates/autosummary/class.rst b/doc/_templates/autosummary/class.rst
@@ -8,8 +8,10 @@
 .. rubric:: Attributes
 
 {% for item in attributes %}
-.. autoproperty::
+{% if item not in inherited_members %}
+.. autoattribute::
     {{ objname }}.{{ item }}
+{% endif %}
 {% endfor %}
 {% endif %}
 

diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -248,7 +248,7 @@ Enumerations
 .. autosummary::
     :toctree: generated
 
-    enums
+    enums.GridID
 
 Exceptions
 ----------

diff --git a/pygmt/enums.py b/pygmt/enums.py
@@ -12,28 +12,28 @@ class GridID(IntEnum):
     These enums are defined in 'gmt_grdio.h'.
     """
 
-    UNKNOWN = 0  # If grid format cannot be auto-detected
-    BF = 1  # GMT native, C-binary format (32-bit float)
-    BS = 2  # GMT native, C-binary format (16-bit integer)
-    RB = 3  # SUN rasterfile format (8-bit standard)
-    BB = 4  # GMT native, C-binary format (8-bit integer)
-    BM = 5  # GMT native, C-binary format (bit-mask)
-    SF = 6  # Golden Software Surfer format 6 (32-bit float)
-    CB = 7  # GMT netCDF format (8-bit integer, depreciated)
-    CS = 8  # GMT netCDF format (16-bit integer, depreciated)
-    CI = 9  # GMT netCDF format (32-bit integer, depreciated)
-    CF = 10  # GMT netCDF format (32-bit float, depreciated)
-    CD = 11  # GMT netCDF format (64-bit float, depreciated)
-    RF = 12  # GEODAS grid format GRD98 (NGDC)
-    BI = 13  # GMT native, C-binary format (32-bit integer)
-    BD = 14  # GMT native, C-binary format (64-bit float)
-    NB = 15  # GMT netCDF format (8-bit integer)
-    NS = 16  # GMT netCDF format (16-bit integer)
-    NI = 17  # GMT netCDF format (32-bit integer)
-    NF = 18  # GMT netCDF format (32-bit float)
-    ND = 19  # GMT netCDF format (64-bit float)
-    SD = 20  # Golden Software Surfer format 7 (64-bit float, read-only)
-    AF = 21  # Atlantic Geoscience Center format AGC (32-bit float)
-    GD = 22  # Import through GDAL
-    EI = 23  # ESRI Arc/Info ASCII Grid Interchange format (ASCII integer)
-    EF = 24  # ESRI Arc/Info ASCII Grid Interchange format (ASCII float)
+    UNKNOWN = 0  #: Unkown grid format
+    BF = 1  #: GMT native, C-binary format (32-bit float)
+    BS = 2  #: GMT native, C-binary format (16-bit integer)
+    RB = 3  #: SUN rasterfile format (8-bit standard)
+    BB = 4  #: GMT native, C-binary format (8-bit integer)
+    BM = 5  #: GMT native, C-binary format (bit-mask)
+    SF = 6  #: Golden Software Surfer format 6 (32-bit float)
+    CB = 7  #: GMT netCDF format (8-bit integer, depreciated)
+    CS = 8  #: GMT netCDF format (16-bit integer, depreciated)
+    CI = 9  #: GMT netCDF format (32-bit integer, depreciated)
+    CF = 10  #: GMT netCDF format (32-bit float, depreciated)
+    CD = 11  #: GMT netCDF format (64-bit float, depreciated)
+    RF = 12  #: GEODAS grid format GRD98 (NGDC)
+    BI = 13  #: GMT native, C-binary format (32-bit integer)
+    BD = 14  #: GMT native, C-binary format (64-bit float)
+    NB = 15  #: GMT netCDF format (8-bit integer)
+    NS = 16  #: GMT netCDF format (16-bit integer)
+    NI = 17  #: GMT netCDF format (32-bit integer)
+    NF = 18  #: GMT netCDF format (32-bit float)
+    ND = 19  #: GMT netCDF format (64-bit float)
+    SD = 20  #: Golden Software Surfer format 7 (64-bit float, read-only)
+    AF = 21  #: Atlantic Geoscience Center format AGC (32-bit float)
+    GD = 22  #: Import through GDAL
+    EI = 23  #: ESRI Arc/Info ASCII Grid Interchange format (ASCII integer)
+    EF = 24  #: ESRI Arc/Info ASCII Grid Interchange format (ASCII float)