Skip to content

Commit

Permalink
Add more sections to the API docs (#1643)
Browse files Browse the repository at this point in the history
Co-authored-by: Wei Ji <[email protected]>
  • Loading branch information
Meghan Jones and weiji14 authored Dec 17, 2021
1 parent bbf2a6b commit 24600ee
Showing 1 changed file with 57 additions and 20 deletions.
77 changes: 57 additions & 20 deletions doc/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,51 +10,69 @@ API Reference
Plotting
--------

Figure class overview
~~~~~~~~~~~~~~~~~~~~~

All plotting is handled through the :class:`pygmt.Figure` class and its methods.

.. autosummary::
:toctree: generated

Figure

Plotting data and laying out the map:
Plotting map elements
~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated

Figure.basemap
Figure.coast
Figure.colorbar
Figure.contour
Figure.grdcontour
Figure.grdimage
Figure.grdview
Figure.histogram
Figure.image
Figure.inset
Figure.legend
Figure.logo
Figure.solar
Figure.text

Plotting tabular data
~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated

Figure.contour
Figure.histogram
Figure.meca
Figure.plot
Figure.plot3d
Figure.rose
Figure.set_panel
Figure.shift_origin
Figure.solar
Figure.subplot
Figure.text
Figure.velo
Figure.wiggle

Color palette table generation:
Plotting raster data
~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated

grd2cpt
makecpt
Figure.grdcontour
Figure.grdimage
Figure.grdview
Figure.image

Configuring layout
~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated

Figure.set_panel
Figure.shift_origin
Figure.subplot

Saving and displaying the figure:
Saving and displaying the figure
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated
Expand All @@ -63,18 +81,35 @@ Saving and displaying the figure:
Figure.show
Figure.psconvert

Configuring the display settings:
Configuring the display settings
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The following module is provided directly through the :mod:`pygmt` top level
package.

.. autosummary::
:toctree: generated

set_display

Color palette table generation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The following modules are provided directly through the :mod:`pygmt` top level
package.

.. autosummary::
:toctree: generated

grd2cpt
makecpt


Data Processing
---------------

Operations on tabular data:
Operations on tabular data
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated
Expand All @@ -91,7 +126,8 @@ Operations on tabular data:
surface
xyz2grd

Operations on grids:
Operations on grids
~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated
Expand All @@ -108,7 +144,8 @@ Operations on grids:
grdtrack
grdvolume

Crossover analysis with x2sys:
Crossover analysis with x2sys
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: generated
Expand Down

0 comments on commit 24600ee

Please sign in to comment.