Skip to content

Commit ac6239f

Browse files
committed
Update docs for enums
1 parent 7317b1b commit ac6239f

File tree

3 files changed

+29
-27
lines changed

3 files changed

+29
-27
lines changed

doc/_templates/autosummary/class.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@
88
.. rubric:: Attributes
99

1010
{% for item in attributes %}
11-
.. autoproperty::
11+
{% if item not in inherited_members %}
12+
.. autoattribute::
1213
{{ objname }}.{{ item }}
14+
{% endif %}
1315
{% endfor %}
1416
{% endif %}
1517

doc/api/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ Enumerations
248248
.. autosummary::
249249
:toctree: generated
250250

251-
enums
251+
enums.GridID
252252

253253
Exceptions
254254
----------

pygmt/enums.py

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,28 @@ class GridID(IntEnum):
1212
These enums are defined in 'gmt_grdio.h'.
1313
"""
1414

15-
UNKNOWN = 0 # If grid format cannot be auto-detected
16-
BF = 1 # GMT native, C-binary format (32-bit float)
17-
BS = 2 # GMT native, C-binary format (16-bit integer)
18-
RB = 3 # SUN rasterfile format (8-bit standard)
19-
BB = 4 # GMT native, C-binary format (8-bit integer)
20-
BM = 5 # GMT native, C-binary format (bit-mask)
21-
SF = 6 # Golden Software Surfer format 6 (32-bit float)
22-
CB = 7 # GMT netCDF format (8-bit integer, depreciated)
23-
CS = 8 # GMT netCDF format (16-bit integer, depreciated)
24-
CI = 9 # GMT netCDF format (32-bit integer, depreciated)
25-
CF = 10 # GMT netCDF format (32-bit float, depreciated)
26-
CD = 11 # GMT netCDF format (64-bit float, depreciated)
27-
RF = 12 # GEODAS grid format GRD98 (NGDC)
28-
BI = 13 # GMT native, C-binary format (32-bit integer)
29-
BD = 14 # GMT native, C-binary format (64-bit float)
30-
NB = 15 # GMT netCDF format (8-bit integer)
31-
NS = 16 # GMT netCDF format (16-bit integer)
32-
NI = 17 # GMT netCDF format (32-bit integer)
33-
NF = 18 # GMT netCDF format (32-bit float)
34-
ND = 19 # GMT netCDF format (64-bit float)
35-
SD = 20 # Golden Software Surfer format 7 (64-bit float, read-only)
36-
AF = 21 # Atlantic Geoscience Center format AGC (32-bit float)
37-
GD = 22 # Import through GDAL
38-
EI = 23 # ESRI Arc/Info ASCII Grid Interchange format (ASCII integer)
39-
EF = 24 # ESRI Arc/Info ASCII Grid Interchange format (ASCII float)
15+
UNKNOWN = 0 #: Unkown grid format
16+
BF = 1 #: GMT native, C-binary format (32-bit float)
17+
BS = 2 #: GMT native, C-binary format (16-bit integer)
18+
RB = 3 #: SUN rasterfile format (8-bit standard)
19+
BB = 4 #: GMT native, C-binary format (8-bit integer)
20+
BM = 5 #: GMT native, C-binary format (bit-mask)
21+
SF = 6 #: Golden Software Surfer format 6 (32-bit float)
22+
CB = 7 #: GMT netCDF format (8-bit integer, depreciated)
23+
CS = 8 #: GMT netCDF format (16-bit integer, depreciated)
24+
CI = 9 #: GMT netCDF format (32-bit integer, depreciated)
25+
CF = 10 #: GMT netCDF format (32-bit float, depreciated)
26+
CD = 11 #: GMT netCDF format (64-bit float, depreciated)
27+
RF = 12 #: GEODAS grid format GRD98 (NGDC)
28+
BI = 13 #: GMT native, C-binary format (32-bit integer)
29+
BD = 14 #: GMT native, C-binary format (64-bit float)
30+
NB = 15 #: GMT netCDF format (8-bit integer)
31+
NS = 16 #: GMT netCDF format (16-bit integer)
32+
NI = 17 #: GMT netCDF format (32-bit integer)
33+
NF = 18 #: GMT netCDF format (32-bit float)
34+
ND = 19 #: GMT netCDF format (64-bit float)
35+
SD = 20 #: Golden Software Surfer format 7 (64-bit float, read-only)
36+
AF = 21 #: Atlantic Geoscience Center format AGC (32-bit float)
37+
GD = 22 #: Import through GDAL
38+
EI = 23 #: ESRI Arc/Info ASCII Grid Interchange format (ASCII integer)
39+
EF = 24 #: ESRI Arc/Info ASCII Grid Interchange format (ASCII float)

0 commit comments

Comments
 (0)