docs(sphinx): fixes documentation errors

bayesian_learning_control/control/algos/pytorch/common/get_lr_scheduler.py

@@ -1,13 +1,4 @@
 """Contains functions used for creating Pytorch learning rate schedulers.
-
-.. rubric:: Functions
-
-.. autosummary::
-    :toctree:
-
-    calc_linear_decay_rate
-    get_exponential_decay_rate
-    get_lr_scheduler
 """
 
 from decimal import Decimal

docs/source/conf.py

@@ -23,14 +23,9 @@
 import os.path as osp
 import sys
 
-dirname = osp.dirname
-top_folder = dirname(dirname(dirname(__file__)))
-sys.path.insert(0, osp.join(top_folder, "bayesian_learning_control"))
-sys.path.insert(0, osp.join(top_folder, "examples"))
-sys.path.insert(0, osp.join(top_folder, "bayesian_learning_control", "control"))
-sys.path.insert(0, osp.join(top_folder, "bayesian_learning_control", "hardware"))
-sys.path.insert(0, osp.join(top_folder, "bayesian_learning_control", "modeling"))
-sys.path.insert(0, osp.join(top_folder, "bayesian_learning_control", "simzoo"))
+sys.path.insert(0, osp.abspath("../../bayesian_learning_control"))
+sys.path.insert(1, osp.abspath("../../examples"))
+sys.path.insert(2, osp.abspath("../../bayesian_learning_control/simzoo"))
 
 # -- General configuration ------------------------------------------------
 
@@ -62,21 +57,21 @@ def __getattr__(cls, name):
 extensions = [
     "sphinx.ext.todo",
     "sphinx.ext.imgmath",
-    "sphinx.ext.viewcode",
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.napoleon",
     "sphinx.ext.extlinks",
     "sphinx.ext.githubpages",
     "sphinx.ext.intersphinx",
-    "recommonmark",
+    "sphinx.ext.viewcode",
+    "myst_parser",
 ]
 
 # Extension settings
 autosummary_generate = True
 autosummary_generate_overwrite = True
 autodoc_member_order = "bysource"
-autosummary_imported_members = True
+# autosummary_imported_members = True
 
 # imgmath settings
 imgmath_image_format = "svg"

docs/source/control/eval_robustness.rst

@@ -247,7 +247,7 @@ For a good example of how this is done, one can look at the ``<ENV_NAME>_disturb
 How to find available disturbances
 ==================================
 
-When using the :ref:`robustness eval CLI <eval_robustness>` you can use the ``--list_disturbance_types`` and ``--list_disturbance_variants`` flags to list the available disturbance types and variants for a given agent trained in a given
+When using the :ref:`robustness eval CLI <robustness_eval>` you can use the ``--list_disturbance_types`` and ``--list_disturbance_variants`` flags to list the available disturbance types and variants for a given agent trained in a given
 environment. For more details, one should check the check the ``DISTURBANCE_CFG`` constant inside the :class:`~bayesian_learning_control.simzoo.simzoo.common.disturber.Disturber` class file or the environment
 ``<ENV_NAME>_disturber.py`` file.
 

setup.cfg

@@ -69,7 +69,7 @@ docs =
     sphinx
     sphinx-autobuild
     sphinx-rtd-theme
-    recommonmark
+    myst_parser
 dev =
     %(tf)s
     %(tuning)s