various changes to .readthedocs.yaml, .rsts, etc, trying to get the documentation build to pass and look nice

Author: pavelkomarov

.readthedocs.yaml

@@ -1,7 +1,16 @@
 version: 2
 
+sphinx:
+  configuration: docs/source/conf.py
+
 build:
   os: ubuntu-22.04
-  docs_dir: docs
-  builder: html # Use the 'sphinx' builder (default for 'make html')
+  tools:
+    python: "3.11"
 
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

README.md

@@ -9,8 +9,8 @@ Python methods for numerical differentiation of noisy data, including multi-obje
 </p>
 
 <p align="center">
-    <a href='https://pynumdiff.readthedocs.io/en/master/?badge=master'>
-        <img src='https://readthedocs.org/projects/pynumdiff/badge/?version=master' alt='Documentation Status' /></a>
+    <a href='https://pynumdiff.readthedocs.io/master/'>
+        <img src='https://app.readthedocs.org/projects/pynumdiff/badge/?version=master' alt='Documentation Status' /></a>
     <a href="https://badge.fury.io/py/pynumdiff">
         <img src="https://badge.fury.io/py/pynumdiff.svg" alt="PyPI version" height="18"></a>
     <a href="https://zenodo.org/badge/latestdoi/159711175">

docs/make.bat

@@ -4,7 +4,6 @@ utils
 .. toctree::
    :maxdepth: 1
 
-   utils/_pi_cruise_control
    utils/evaluate
    utils/simulate
    utils/utility

docs/source/utils.rst

@@ -113,8 +113,8 @@ def constant_velocity(x, dt, params=None, options=None, r=None, q=None, forwardb
     :param list[float] params: (**deprecated**, prefer :code:`r` and :code:`q`)
     :param options: (**deprecated**, prefer :code:`forwardbackward`)
         a dictionary consisting of {'forwardbackward': (bool)}
-    param float r: variance of the signal noise
-    param float q: variance of the constant velocity model
+    :param float r: variance of the signal noise
+    :param float q: variance of the constant velocity model
     :param bool forwardbackward: indicates whether to run smoother forwards and backwards
         (usually achieves better estimate at end points)
 
@@ -148,8 +148,8 @@ def constant_acceleration(x, dt, params=None, options=None, r=None, q=None, forw
     :param list[float] params: (**deprecated**, prefer :code:`r` and :code:`q`)
     :param options: (**deprecated**, prefer :code:`forwardbackward`)
         a dictionary consisting of {'forwardbackward': (bool)}
-    param float r: variance of the signal noise
-    param float q: variance of the constant acceleration model
+    :param float r: variance of the signal noise
+    :param float q: variance of the constant acceleration model
     :param bool forwardbackward: indicates whether to run smoother forwards and backwards
         (usually achieves better estimate at end points)
 
@@ -187,8 +187,8 @@ def constant_jerk(x, dt, params=None, options=None, r=None, q=None, forwardbackw
     :param list[float] params: (**deprecated**, prefer :code:`r` and :code:`q`)
     :param options: (**deprecated**, prefer :code:`forwardbackward`)
         a dictionary consisting of {'forwardbackward': (bool)}
-    param float r: variance of the signal noise
-    param float q: variance of the constant jerk model
+    :param float r: variance of the signal noise
+    :param float q: variance of the constant jerk model
     :param bool forwardbackward: indicates whether to run smoother forwards and backwards
         (usually achieves better estimate at end points)
 
@@ -237,7 +237,7 @@ def known_dynamics(x, params, u=None, options=None, xhat0=None, P0=None, A=None,
     :param np.array C: measurement dynamics, MxN
     :param np.array Q: covariance matrix for the model, NxN
     :param np.array R: covariance matrix for the measurements, MxM
-    :parma bool smooth: whether to run the RTS smoother step
+    :param bool smooth: whether to run the RTS smoother step
 
     :return: np.array **x_hat** -- estimated (smoothed) x
     """ # Why not also returning derivative here?

docs/source/utils/_pi_cruise_control.rst

@@ -8,16 +8,16 @@ def hankel_matrix(x, num_delays, pad=False): # fixed delay step of 1
     :param np.array[float] x: data
     :param int num_delays: number of times to 1-step shift data
     :param bool pad: if True, return width is len(x), else width is len(x) - num_delays + 1
-    :return: a Hankel Matrix m
-            e.g. if x = [a, b, c, d, e] and num_delays = 3
-            then with pad = False:
-                    m = [['a', 'b', 'c'],
-                         ['b', 'c', 'd'],
-                         ['c', 'd', 'e']]
-            or pad = True:
-                    m = [['a', 'b', 'c', 'd', 'e'],
-                         ['b', 'c', 'd', 'e',  0],
-                         ['c', 'd', 'e',  0,   0]]
+
+    :return: a Hankel Matrix `m`. For example, if `x = [a, b, c, d, e]` and `num_delays = 3`:\n
+        With `pad = False`::\n
+            m = [[a, b, c],
+                 [b, c, d],
+                 [c, d, e]]\n
+        With `pad = True`::\n
+            m = [[a, b, c, d, e],
+                 [b, c, d, e, 0],
+                 [c, d, e, 0, 0]]
     """
     m = x.copy()
     for d in range(1, num_delays):

pynumdiff/kalman_smooth/_kalman_smooth.py

@@ -46,6 +46,11 @@ dev = [
     "cvxpy",
     "Mosek"
 ]
+docs = [
+    "sphinx",
+    "sphinx_rtd_theme",
+    "cvxpy"
+]
 
 [tool.setuptools_scm]
 write_to = "pynumdiff/_version.py"