From 7a7f169573998a400fd4378e30748800374b08c6 Mon Sep 17 00:00:00 2001 From: Shane Elipot Date: Sun, 17 Sep 2023 12:46:59 -0400 Subject: [PATCH] add wavelet module to doc? (#268) * add wavelet module to documentation * fix the few warnings after generating the doc * lint --------- Co-authored-by: Philippe Miron --- clouddrift/wavelet.py | 3 ++- docs/api.rst | 11 +++++++++-- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/clouddrift/wavelet.py b/clouddrift/wavelet.py index 3cf22c16..fd3d999e 100644 --- a/clouddrift/wavelet.py +++ b/clouddrift/wavelet.py @@ -654,7 +654,7 @@ def morse_logspace_freq( >>> radian_frequency = morse_logspace_freq(3,5,1024,highset=(0.2,np.pi),lowset=(5,0),density=10) - See Also + See Also -------- :func:`morse_wavelet`, `morse_freq`, `morse_properties`. """ @@ -725,6 +725,7 @@ def morse_properties( kurt: np.ndarray or float Normalized fourth moment of the time-domain demodulate, or 'demodulate kurtosis'. + See Also -------- :func:`morse_wavelet`, `morse_freq`, `morse_amplitude`, `morse_logspace_freq`. diff --git a/docs/api.rst b/docs/api.rst index 9fb13dfd..fede5f04 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -71,15 +71,22 @@ RaggedArray :undoc-members: Sphere ---------- +------ .. automodule:: clouddrift.sphere :members: :undoc-members: Signal ---------- +------ .. automodule:: clouddrift.signal :members: :undoc-members: + +Wavelet +------- + +.. automodule:: clouddrift.wavelet + :members: + :undoc-members: \ No newline at end of file