Skip to content

Commit 24600ee

Browse files
Meghan Jonesweiji14
andauthored
Add more sections to the API docs (#1643)
Co-authored-by: Wei Ji <[email protected]>
1 parent bbf2a6b commit 24600ee

File tree

1 file changed

+57
-20
lines changed

1 file changed

+57
-20
lines changed

doc/api/index.rst

Lines changed: 57 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,51 +10,69 @@ API Reference
1010
Plotting
1111
--------
1212

13+
Figure class overview
14+
~~~~~~~~~~~~~~~~~~~~~
15+
1316
All plotting is handled through the :class:`pygmt.Figure` class and its methods.
1417

1518
.. autosummary::
1619
:toctree: generated
1720

1821
Figure
1922

20-
Plotting data and laying out the map:
23+
Plotting map elements
24+
~~~~~~~~~~~~~~~~~~~~~
2125

2226
.. autosummary::
2327
:toctree: generated
2428

2529
Figure.basemap
2630
Figure.coast
2731
Figure.colorbar
28-
Figure.contour
29-
Figure.grdcontour
30-
Figure.grdimage
31-
Figure.grdview
32-
Figure.histogram
33-
Figure.image
3432
Figure.inset
3533
Figure.legend
3634
Figure.logo
35+
Figure.solar
36+
Figure.text
37+
38+
Plotting tabular data
39+
~~~~~~~~~~~~~~~~~~~~~
40+
41+
.. autosummary::
42+
:toctree: generated
43+
44+
Figure.contour
45+
Figure.histogram
3746
Figure.meca
3847
Figure.plot
3948
Figure.plot3d
4049
Figure.rose
41-
Figure.set_panel
42-
Figure.shift_origin
43-
Figure.solar
44-
Figure.subplot
45-
Figure.text
4650
Figure.velo
4751
Figure.wiggle
4852

49-
Color palette table generation:
53+
Plotting raster data
54+
~~~~~~~~~~~~~~~~~~~~
5055

5156
.. autosummary::
5257
:toctree: generated
5358

54-
grd2cpt
55-
makecpt
59+
Figure.grdcontour
60+
Figure.grdimage
61+
Figure.grdview
62+
Figure.image
63+
64+
Configuring layout
65+
~~~~~~~~~~~~~~~~~~
66+
67+
.. autosummary::
68+
:toctree: generated
69+
70+
Figure.set_panel
71+
Figure.shift_origin
72+
Figure.subplot
5673

57-
Saving and displaying the figure:
74+
Saving and displaying the figure
75+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5876

5977
.. autosummary::
6078
:toctree: generated
@@ -63,18 +81,35 @@ Saving and displaying the figure:
6381
Figure.show
6482
Figure.psconvert
6583

66-
Configuring the display settings:
84+
Configuring the display settings
85+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
86+
87+
The following module is provided directly through the :mod:`pygmt` top level
88+
package.
6789

6890
.. autosummary::
6991
:toctree: generated
7092

7193
set_display
7294

95+
Color palette table generation
96+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
97+
98+
The following modules are provided directly through the :mod:`pygmt` top level
99+
package.
100+
101+
.. autosummary::
102+
:toctree: generated
103+
104+
grd2cpt
105+
makecpt
106+
73107

74108
Data Processing
75109
---------------
76110

77-
Operations on tabular data:
111+
Operations on tabular data
112+
~~~~~~~~~~~~~~~~~~~~~~~~~~
78113

79114
.. autosummary::
80115
:toctree: generated
@@ -91,7 +126,8 @@ Operations on tabular data:
91126
surface
92127
xyz2grd
93128

94-
Operations on grids:
129+
Operations on grids
130+
~~~~~~~~~~~~~~~~~~~
95131

96132
.. autosummary::
97133
:toctree: generated
@@ -108,7 +144,8 @@ Operations on grids:
108144
grdtrack
109145
grdvolume
110146

111-
Crossover analysis with x2sys:
147+
Crossover analysis with x2sys
148+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112149

113150
.. autosummary::
114151
:toctree: generated

0 commit comments

Comments
 (0)