rtd-theme?

aewallin · Nov 27, 2023 · 546d7a9 · 546d7a9
1 parent 56b1054
commit 546d7a9
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 18 deletions.
diff --git a/allantools/allantools.py b/allantools/allantools.py
@@ -135,8 +135,6 @@ def tdev(data, rate=1.0, data_type="phase", taus=None):
 
     Note that TDEV has a unit of seconds.
 
-    NIST [SP1065]_ eqn (15), page 18.
-
     Parameters
     ----------
     data: np.array
@@ -164,9 +162,10 @@ def tdev(data, rate=1.0, data_type="phase", taus=None):
     ns: np.array
         Values of N used in mdev_phase()
 
-    Notes
-    -----
-    http://en.wikipedia.org/wiki/Time_deviation
+    References
+    ----------
+    * http://en.wikipedia.org/wiki/Time_deviation
+    * NIST [SP1065]_ eqn (15), page 18.
     """
     phase = input_to_phase(data, rate, data_type)
     (taus, md, mde, ns) = mdev(phase, rate=rate, taus=taus)

diff --git a/allantools/noise_kasdin.py b/allantools/noise_kasdin.py
@@ -48,20 +48,21 @@ class Noise(object):
     qd: float
         discrete variance
     b: float
+        noise type
     
-        +----+--------------------------------------------+
-        | b  |  noise type                                |
-        +====+============================================+
-        | 0  | White Phase Modulation (WPM)               |
-        +----+--------------------------------------------+
-        | -1 | Flicker Phase Modulation (FPM)             |
-        +----+--------------------------------------------+
-        | -2 | White Frequency Modulation (WFM)           |
-        +----+--------------------------------------------+
-        | -3 | Flicker Frequency Modulation (FFM)         |
-        +----+--------------------------------------------+
-        | -4 | Random Walk Frequency Modulation (RWFM)    |
-        +----+--------------------------------------------+
+    +----+--------------------------------------------+
+    | b  |  noise type                                |
+    +====+============================================+
+    | 0  | White Phase Modulation (WPM)               |
+    +----+--------------------------------------------+
+    | -1 | Flicker Phase Modulation (FPM)             |
+    +----+--------------------------------------------+
+    | -2 | White Frequency Modulation (WFM)           |
+    +----+--------------------------------------------+
+    | -3 | Flicker Frequency Modulation (FFM)         |
+    +----+--------------------------------------------+
+    | -4 | Random Walk Frequency Modulation (RWFM)    |
+    +----+--------------------------------------------+
 
     Returns
     -------

diff --git a/requirements.txt b/requirements.txt
@@ -3,3 +3,4 @@ scipy
 numpydoc
 matplotlib
 pytest
+sphinx_rtd_theme