Merge pull request #198 from NeLy-EPFL/site-formatting-change

Site formatting change

doc/source/tutorials/advanced_olfaction.rst

@@ -1,16 +1,18 @@
 Advanced olfaction: Navigating a complex odor plume
 ===================================================
 
-**Author:** Victor Alfred Stimpfling
+.. note::
 
-**Note:** The code presented in this notebook has been simplified and
-restructured for display in a notebook format. A more complete and
-better structured implementation can be found in the `examples folder of
-the FlyGym repository on
-GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+    **Author:** Victor Alfred Stimpfling
 
-**Notebook Format:** This tutorial is available in `.ipynb` format in the
-`notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
+    The code presented in this notebook has been simplified and
+    restructured for display in a notebook format. A more complete and
+    better structured implementation can be found in the `examples folder of
+    the FlyGym repository on
+    GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+
+    This tutorial is available in ``.ipynb`` format in the
+    `notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
 
 **Summary**: In this tutorial, we simulate a complex odor plume, replay
 the plume in MuJoCo, and build a simple controller to navigate it.

doc/source/tutorials/advanced_vision.rst

@@ -1,16 +1,18 @@
 Connectome-constrained visual system model
 ==========================================
 
-**Authors:** Thomas Ka Chung Lam, Sibo Wang-Chen
+.. note::
 
-**Note:** The code presented in this notebook has been simplified and
-restructured for display in a notebook format. A more complete and
-better structured implementation can be found in the `examples folder of
-the FlyGym repository on
-GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+    **Authors:** Thomas Ka Chung Lam, Sibo Wang-Chen
 
-**Notebook Format:** This tutorial is available in `.ipynb` format in the
-`notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
+    The code presented in this notebook has been simplified and
+    restructured for display in a notebook format. A more complete and
+    better structured implementation can be found in the `examples folder of
+    the FlyGym repository on
+    GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+
+    This tutorial is available in ``.ipynb`` format in the
+    `notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
 
 **Summary**: In this tutorial, we will (1) simulate two flies in the
 same arena, and (2) integrate a connectome-constrained visual system

doc/source/tutorials/cpg_controller.rst

@@ -1,16 +1,18 @@
 Controlling locomotion with CPGs
 ================================
 
-**Authors:** Sibo Wang-Chen, Femke Hurtak
+.. note::
 
-**Note:** The code presented in this notebook has been simplified and
-restructured for display in a notebook format. A more complete and
-better structured implementation can be found in the `examples folder of
-the FlyGym repository on
-GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+    **Authors:** Sibo Wang-Chen, Femke Hurtak
 
-**Notebook Format:** This tutorial is available in `.ipynb` format in the
-`notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
+    The code presented in this notebook has been simplified and
+    restructured for display in a notebook format. A more complete and
+    better structured implementation can be found in the `examples folder of
+    the FlyGym repository on
+    GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+
+    This tutorial is available in ``.ipynb`` format in the
+    `notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
 
 **Summary:** In this tutorial, we will introduce the concept of Central
 Pattern Generators (CPGs) and build a CPG-based model to control walking

doc/source/tutorials/gym_basics_and_kinematic_replay.rst

@@ -1,16 +1,12 @@
 Interacting with NeuroMechFly
 =============================
 
-**Author:** Sibo Wang-Chen
+.. note::
 
-**Note:** The code presented in this notebook has been simplified and
-restructured for display in a notebook format. A more complete and
-better structured implementation can be found in the `examples folder of
-the FlyGym repository on
-GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+    **Author:** Sibo Wang-Chen
 
-**Notebook Format:** This tutorial is available in `.ipynb` format in the
-`notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
+    This tutorial is available in ``.ipynb`` format in the
+    `notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
 
 **Summary:** In this tutorial, we will introduce the basic concepts of
 interacting with the simulated fly in a Markov Decision Process using

doc/source/tutorials/head_stabilization.rst

@@ -1,13 +1,18 @@
 Head stabilization
 ==================
 
-**Author:** Sibo Wang-Chen
+.. note::
 
-**Note:** The code presented in this notebook has been simplified and
-restructured for display in a notebook format. A more complete and
-better structured implementation can be found in the `examples folder of
-the FlyGym repository on
-GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+    **Author:** Sibo Wang-Chen
+
+    The code presented in this notebook has been simplified and
+    restructured for display in a notebook format. A more complete and
+    better structured implementation can be found in the `examples folder of
+    the FlyGym repository on
+    GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+
+    This tutorial is available in ``.ipynb`` format in the
+    `notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
 
 **Summary:** In this tutorial, we will use mechanosensory information to
 correct for self motion in closed loop. We will train an internal model

doc/source/tutorials/hybrid_controller.rst

@@ -1,16 +1,18 @@
 Overcome complex terrain with a hybrid controller
 =================================================
 
-**Authors:** Victor Alfred Stimpfling, Sibo Wang-Chen
+.. note::
 
-**Note:** The code presented in this notebook has been simplified and
-restructured for display in a notebook format. A more complete and
-better structured implementation can be found in the `examples folder of
-the FlyGym repository on
-GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+    **Authors:** Victor Alfred Stimpfling, Sibo Wang-Chen
 
-**Notebook Format:** This tutorial is available in `.ipynb` format in the
-`notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
+    The code presented in this notebook has been simplified and
+    restructured for display in a notebook format. A more complete and
+    better structured implementation can be found in the `examples folder of
+    the FlyGym repository on
+    GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+
+    This tutorial is available in ``.ipynb`` format in the
+    `notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
 
 **Summary**: In this tutorial, we will illustrate how CPG- and
 rule-based controllers fail to produce robust locomotion over complex

doc/source/tutorials/olfaction_basics.rst

@@ -1,16 +1,18 @@
 Olfaction basics
 ================
 
-**Author:** Sibo Wang-Chen
+.. note::
 
-**Note:** The code presented in this notebook has been simplified and
-restructured for display in a notebook format. A more complete and
-better structured implementation can be found in the `examples folder of
-the FlyGym repository on
-GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+    **Author:** Sibo Wang-Chen
 
-**Notebook Format:** This tutorial is available in `.ipynb` format in the
-`notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
+    The code presented in this notebook has been simplified and
+    restructured for display in a notebook format. A more complete and
+    better structured implementation can be found in the `examples folder of
+    the FlyGym repository on
+    GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+
+    This tutorial is available in ``.ipynb`` format in the
+    `notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
 
 **Summary:** In this tutorial, we will implement a simple controller for
 odor-guided taxis.

doc/source/tutorials/path_integration.rst

@@ -1,16 +1,18 @@
 Path integration
 ================
 
-**Author:** Sibo Wang-Chen
+.. note::
 
-**Note:** The code presented in this notebook has been simplified and
-restructured for display in a notebook format. A more complete and better
-structured implementation can be found in the
-`examples folder of the FlyGym repository on
-GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+    **Author:** Sibo Wang-Chen
 
-**Notebook Format:** This tutorial is available in `.ipynb` format in the
-`notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
+    The code presented in this notebook has been simplified and
+    restructured for display in a notebook format. A more complete and better
+    structured implementation can be found in the
+    `examples folder of the FlyGym repository on
+    GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+
+    This tutorial is available in ``.ipynb`` format in the
+    `notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
 
 **Summary:** In this tutorial, we will show how the position and heading
 of the animal can be estimated by integrating mechanosensory signals, a

doc/source/tutorials/rule_based_controller.rst

@@ -1,16 +1,18 @@
 Rule-based controller
 =====================
 
-**Authors:** Victor Alfred Stimpfling, Sibo Wang-Chen
+.. note::
 
-**Note:** The code presented in this notebook has been simplified and
-restructured for display in a notebook format. A more complete and
-better structured implementation can be found in the `examples folder of
-the FlyGym repository on
-GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+    **Authors:** Victor Alfred Stimpfling, Sibo Wang-Chen
 
-**Notebook Format:** This tutorial is available in `.ipynb` format in the
-`notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
+    The code presented in this notebook has been simplified and
+    restructured for display in a notebook format. A more complete and
+    better structured implementation can be found in the `examples folder of
+    the FlyGym repository on
+    GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+
+    This tutorial is available in ``.ipynb`` format in the
+    `notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
 
 **Summary:** In this tutorial, we will show how locomotion can be
 achieved using local coordination rules in the absence of centralized

doc/source/tutorials/turning.rst

@@ -1,16 +1,18 @@
 Encapsulating custom code into Gym environments: A turning controller
 =====================================================================
 
-**Authors:** Victor Alfred Stimpfling, Sibo Wang-Chen
+.. note::
 
-**Note:** The code presented in this notebook has been simplified and
-restructured for display in a notebook format. A more complete and
-better structured implementation can be found in the `examples folder of
-the FlyGym repository on
-GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+    **Authors:** Victor Alfred Stimpfling, Sibo Wang-Chen
 
-**Notebook Format:** This tutorial is available in `.ipynb` format in the
-`notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
+    The code presented in this notebook has been simplified and
+    restructured for display in a notebook format. A more complete and
+    better structured implementation can be found in the `examples folder of
+    the FlyGym repository on
+    GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+
+    This tutorial is available in ``.ipynb`` format in the
+    `notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
 
 **Summary:** In this tutorial, we will demonstrate how one can build
 controllers at different levels of abstraction by implementing Gym

doc/source/tutorials/vision_basics.rst

@@ -1,16 +1,18 @@
 Vision basics
 =============
 
-**Author:** Sibo Wang-Chen
+.. note::
 
-**Note:** The code presented in this notebook has been simplified and
-restructured for display in a notebook format. A more complete and
-better structured implementation can be found in the `examples folder of
-the FlyGym repository on
-GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+    **Author:** Sibo Wang-Chen
 
-**Notebook Format:** This tutorial is available in `.ipynb` format in the
-`notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
+    The code presented in this notebook has been simplified and
+    restructured for display in a notebook format. A more complete and
+    better structured implementation can be found in the `examples folder of
+    the FlyGym repository on
+    GitHub <https://github.com/NeLy-EPFL/flygym/tree/main/flygym/examples/>`__.
+
+    This tutorial is available in ``.ipynb`` format in the
+    `notebooks folder of the FlyGym repository <https://github.com/NeLy-EPFL/flygym/tree/main/notebooks>`_.
 
 **Summary:** In this tutorial, we will build a simple model to control
 the fly to follow a moving sphere. By doing so, we will also demonstrate