Skip to content

Commit

Permalink
Fix: Use proper RST header formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
simmsa committed May 14, 2024
1 parent c7bcea0 commit 5ca9ab7
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/source/mhkit-python/api.wave.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ NDBC
~mhkit.wave.io.ndbc.create_directional_spectrum

SWAN
""""""""""""""""
""""

.. autosummary::
:nosignatures:
Expand All @@ -75,15 +75,15 @@ SWAN


WEC-Sim
""""""""""""""""
"""""""

.. autosummary::
:nosignatures:

~mhkit.wave.io.wecsim.read_output

WPTO Hindcast
""""""""""""""""
"""""""""""""

.. autosummary::
:nosignatures:
Expand All @@ -93,7 +93,7 @@ WPTO Hindcast
~mhkit.wave.io.hindcast.hindcast.request_wpto_directional_spectrum

WIND Toolkit Hindcast
""""""""""""""""
"""""""""""""""""""""

.. autosummary::
:nosignatures:
Expand Down Expand Up @@ -157,7 +157,7 @@ WIND Toolkit Data
:show-inheritance:

Resource
""""""""""""
""""""""
The resource submodule contains functions compute wave energy spectra
and metrics.

Expand Down Expand Up @@ -199,7 +199,7 @@ The following functions can be used to compute wave metrics from spectra:
:show-inheritance:

Performance
""""""""""""
"""""""""""
The performance submodule contains functions to compute capture length,
statistics, performance matrices, and mean annual energy production.

Expand All @@ -223,7 +223,7 @@ statistics, performance matrices, and mean annual energy production.
.. TODO Add Watch circle
Graphics
""""""""""""
""""""""
The graphics submodule contains functions to plot wave data and related metrics.

.. autosummary::
Expand All @@ -245,7 +245,7 @@ The graphics submodule contains functions to plot wave data and related metrics.
:show-inheritance:

Contours
""""""""""""
""""""""
Contains functions for calculating environmental contours of extreme seastates

.. autosummary::
Expand Down

0 comments on commit 5ca9ab7

Please sign in to comment.