docs: fix math (#162)

rickstaa · Jun 23, 2023 · 3b78238 · 3b78238
1 parent a194a56
commit 3b78238
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 1 deletion.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -36,6 +36,7 @@
     "autoapi.extension",  # Generate API documentation from code.
 ]
 autoapi_dirs = ["../../stable_gym"]
+myst_heading_anchors = 2  # Add anchors to headings.
 
 # Extensions settings.
 autodoc_member_order = "bysource"

diff --git a/stable_gym/envs/classic_control/ex3_ekf/__init__.py b/stable_gym/envs/classic_control/ex3_ekf/__init__.py
@@ -3,6 +3,7 @@
 The dynamic system whose state is to be estimated:
 
 .. math::
+
     x(k+1)=Ax(k)+w(k)
     x_1: angle
     x_2: frequency

diff --git a/stable_gym/envs/classic_control/ex3_ekf/ex3_ekf.py b/stable_gym/envs/classic_control/ex3_ekf/ex3_ekf.py
@@ -58,7 +58,8 @@ class Ex3EKF(gym.Env, Ex3EKFDisturber):
         A cost, computed as the sum of the squared differences between the estimated and the actual states:
 
         .. math::
-            C = {(\hat{x}_1 - x_1)}^2 + {(\hat{x}_2 - x_2)}^2
+
+            C = {(\\hat{x}_1 - x_1)}^2 + {(\\hat{x}_2 - x_2)}^2
 
     Starting State:
         All observations are assigned a uniform random value in ``[-0.05..0.05]``