More docs tweaks/reorgs.

bluescarni · Aug 9, 2023 · c614c13 · c614c13
1 parent 4157a78
commit c614c13
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 26 deletions.
diff --git a/doc/tutorials.rst → doc/advanced_tutorials.rst b/doc/tutorials.rst → doc/advanced_tutorials.rst
@@ -1,7 +1,7 @@
-.. _tutorials:
+.. _adv_tutorials:
 
-Tutorials
-=========
+Advanced tutorials
+==================
 
 .. only:: html
 
@@ -23,24 +23,6 @@ Tutorials
      the features currently
      available only in the development version of heyoka.py.
 
-Basics
--------
-
-.. toctree::
-  :maxdepth: 1
-
-  tut_taylor_method
-  notebooks/The expression system.ipynb
-  notebooks/The adaptive integrator.ipynb
-  notebooks/Customising the adaptive integrator.ipynb
-  notebooks/ODEs with parameters.ipynb
-  notebooks/Non-autonomous systems.ipynb
-  notebooks/Dense output.ipynb
-  notebooks/Event detection
-
-Advanced
---------
-
 .. toctree::
   :maxdepth: 1
 

diff --git a/doc/basic_tutorials.rst b/doc/basic_tutorials.rst
@@ -0,0 +1,36 @@
+.. _basic_tutorials:
+
+Basic tutorials
+===============
+
+.. only:: html
+
+  .. important::
+
+     .. raw:: html
+
+        <p>
+        Most of these tutorials can be launched as online interactive notebooks
+        thanks to the infrastructure provided by <a href="https://mybinder.org/">binder</a>.
+        Look for the rocket icon <i class="fas fa-rocket"></i> on top of each page!
+        </p>
+
+  .. important::
+
+     Some tutorials may use features not available yet in the latest stable release
+     of heyoka.py, and thus might fail to execute correctly in the online interactive
+     notebooks. Please refer to the :ref:`changelog <changelog>` for an overview of
+     the features currently
+     available only in the development version of heyoka.py.
+
+.. toctree::
+  :maxdepth: 1
+
+  tut_taylor_method
+  notebooks/The expression system.ipynb
+  notebooks/The adaptive integrator.ipynb
+  notebooks/Customising the adaptive integrator.ipynb
+  notebooks/ODEs with parameters.ipynb
+  notebooks/Non-autonomous systems.ipynb
+  notebooks/Dense output.ipynb
+  notebooks/Event detection
diff --git a/doc/index.md b/doc/index.md
@@ -72,7 +72,8 @@ The authors are Francesco Biscani and Dario Izzo (European Space Agency).
 :caption: Contents
 
 install
-tutorials
+basic_tutorials
+advanced_tutorials
 examples
 benchmarks
 changelog

diff --git a/doc/notebooks/ex_system_revisited.ipynb b/doc/notebooks/ex_system_revisited.ipynb
@@ -7,7 +7,7 @@
    "source": [
     "(ex_system_rev)=\n",
     "\n",
-    "# The expression system, revisited\n",
+    "# Using the expression system effectively\n",
     "\n",
     "## Long sums and products\n",
     "\n",
@@ -1400,7 +1400,7 @@
    "id": "5c56d8f1-4acd-4e6f-80fc-60bb6c6edacb",
    "metadata": {},
    "source": [
-    "This is clearly a marked improvement with respect to the quadratic complexity of the gradient compute via ``diff()``.\n",
+    "This is clearly a marked improvement with respect to the quadratic complexity of the gradient computed via ``diff()``.\n",
     "\n",
     "### General guidelines\n",
     "\n",

diff --git a/doc/notebooks/sympy_interop.ipynb b/doc/notebooks/sympy_interop.ipynb
@@ -15,8 +15,6 @@
     "\n",
     "In this tutorial, we will show how SymPy interoperability can be used for expression simplification purposes, which ultimately leads to a measurable performance increase in the numerical integration of a system of ODEs.\n",
     "\n",
-    "> **NOTE**: [another tutorial](<./tides_spokes.ipynb>) showcasing a more complex interaction between heyoka.py and SymPy is available.\n",
-    "\n",
     "For this example, we will consider the relativistic dynamics of Mercury's orbit around the Sun, which, in the first post-Newtonian approximation, can be described by the following Hamiltonian:\n",
     "\n",
     "$$\n",