add wavelet module to doc? (Cloud-Drift#268)

* add wavelet module to documentation * fix the few warnings after generating the doc * lint --------- Co-authored-by: Philippe Miron <philippe.miron@dtn.com>
philippemiron · Nov 16, 2023 · 7a7f169 · 7a7f169
1 parent a5300fb
commit 7a7f169
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git 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
@@ -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: