diff --git a/doc/source/api/cps.rst b/doc/source/api/cps.rst index 7156231..692470d 100644 --- a/doc/source/api/cps.rst +++ b/doc/source/api/cps.rst @@ -1,8 +1,17 @@ CPS === +surf96 +------ + .. autofunction:: disba.surf96 +swegn96 +------- + .. autofunction:: disba.swegn96 +srfker96 +-------- + .. autofunction:: disba.srfker96 diff --git a/doc/source/api/dispersion.rst b/doc/source/api/dispersion.rst index 16e3370..fa15b28 100644 --- a/doc/source/api/dispersion.rst +++ b/doc/source/api/dispersion.rst @@ -1,15 +1,21 @@ Dispersion ========== +.. autoclass:: disba.DispersionCurve + :members: + +PhaseDispersion +--------------- + .. autoclass:: disba.PhaseDispersion :members: :inherited-members: :special-members: __call__ +GroupDispersion +--------------- + .. autoclass:: disba.GroupDispersion :members: :inherited-members: :special-members: __call__ - -.. autoclass:: disba.DispersionCurve - :members: diff --git a/doc/source/api/eigen.rst b/doc/source/api/eigen.rst index 21c677b..c20f88a 100644 --- a/doc/source/api/eigen.rst +++ b/doc/source/api/eigen.rst @@ -1,13 +1,16 @@ Eigenfunction ============= -.. autoclass:: disba.EigenFunction - :members: - :inherited-members: - :special-members: __call__ - .. autoclass:: disba.RayleighEigen :members: .. autoclass:: disba.LoveEigen :members: + +EigenFunction +------------- + +.. autoclass:: disba.EigenFunction + :members: + :inherited-members: + :special-members: __call__ diff --git a/doc/source/api/ellipticity.rst b/doc/source/api/ellipticity.rst index 653b826..e82f7ad 100644 --- a/doc/source/api/ellipticity.rst +++ b/doc/source/api/ellipticity.rst @@ -1,10 +1,13 @@ Ellipticity =========== +.. autoclass:: disba.RayleighEllipticity + :members: + +Ellipticity +----------- + .. autoclass:: disba.Ellipticity :members: :inherited-members: :special-members: __call__ - -.. autoclass:: disba.RayleighEllipticity - :members: diff --git a/doc/source/api/misc.rst b/doc/source/api/misc.rst index e1f1c2a..1af8dda 100644 --- a/doc/source/api/misc.rst +++ b/doc/source/api/misc.rst @@ -1,4 +1,12 @@ Miscellaneous ============= +depthplot +--------- + .. autofunction:: disba.depthplot + +resample +-------- + +.. autofunction:: disba.resample diff --git a/doc/source/api/sensitivity.rst b/doc/source/api/sensitivity.rst index 4443595..3ae9187 100644 --- a/doc/source/api/sensitivity.rst +++ b/doc/source/api/sensitivity.rst @@ -1,20 +1,29 @@ Sensitivity kernel ================== +.. autoclass:: disba.SensitivityKernel + :members: + +PhaseSensitivity +---------------- + .. autoclass:: disba.PhaseSensitivity :members: :inherited-members: :special-members: __call__ +GroupSensitivity +---------------- + .. autoclass:: disba.GroupSensitivity :members: :inherited-members: :special-members: __call__ +EllipticitySensitivity +---------------------- + .. autoclass:: disba.EllipticitySensitivity :members: :inherited-members: :special-members: __call__ - -.. autoclass:: disba.SensitivityKernel - :members: \ No newline at end of file