Hyperlinks in rst

narahahn · narahahn · commit 0a29ddb102f5 · 2019-03-11T21:23:38.000+01:00
diff --git a/doc/examples/animations-pulsating-sphere.ipynb b/doc/examples/animations-pulsating-sphere.ipynb
@@ -28,15 +28,18 @@
     "particle velocity, and particle displacement, are simulated.\n",
     "The first two quantities are computed with\n",
     "\n",
-    "- `sfs.mono.source.pulsating_sphere()` and\n",
-    "- `sfs.mono.source.pulsating_sphere_velocity()`,\n",
+    "- [sfs.mono.source.pulsating_sphere()](../sfs.mono.source.rst#sfs.mono.source.pulsating_sphere) and \n",
+    "- [sfs.mono.source.pulsating_sphere_velocity()](../sfs.mono.source.rst#sfs.mono.source.pulsating_sphere_velocity)\n",
+    "\n",
+    "while the last one can be obtained by using\n",
+    "\n",
+    "- [sfs.util.displacement()](../sfs.util.rst#sfs.util.displacement)\n",
     "\n",
-    "while the last one can be obtained by using `sfs.util.displacement()`\n",
     "which converts the particle velocity into displacement.\n",
     "\n",
     "A couple of additional functions are implemented in\n",
     "\n",
-    "[`animations_pulsating_sphere.py`](animations_pulsating_sphere.py)\n",
+    "- [animations_pulsating_sphere.py](animations_pulsating_sphere.py)\n",
     "\n",
     "in order to help creating animating pictures, which is fun!"
    ]
@@ -261,12 +264,12 @@
     "Notice that the sound pressure exceeds\n",
     "the atmospheric pressure ($\\approx 10^5$ Pa), which of course makes no sense.\n",
     "This is due to the large amplitude (50 mm) of the pulsating motion.\n",
-    "Although quite unrealistic, it makes easier to observe the particle movements\n",
+    "It was chosen to better visualize the particle movements\n",
     "in the earlier animations.\n",
     "\n",
     "For 1 kHz, the amplitude corresponding to a moderate sound pressure,\n",
-    "let say 1 Pa, is in order of micrometer.\n",
-    "Since it is very small compared to the corresponding wavelength (0.343 m),\n",
+    "let say 1 Pa, is in the order of micrometer.\n",
+    "As it is very small compared to the corresponding wavelength (0.343 m),\n",
     "the movement of the particles and the spatial structure of the sound field\n",
     "cannot be observed simultaneously.\n",
     "Furthermore, at high frequencies, the sound pressure\n",
diff --git a/doc/examples/animations_pulsating_sphere.py b/doc/examples/animations_pulsating_sphere.py
@@ -8,7 +8,6 @@
 def particle_displacement(omega, center, radius, amplitude, grid, frames,
                           figsize=(8, 8), interval=80, blit=True, **kwargs):
     """Generate sound particle animation."""
-
     velocity = sfs.mono.source.pulsating_sphere_velocity(
                omega, center, radius, amplitude, grid)
     displacement = sfs.util.displacement(velocity, omega)
@@ -33,7 +32,6 @@ def update_frame_displacement(i):
 def particle_velocity(omega, center, radius, amplitude, grid, frames,
                       figsize=(8, 8), interval=80, blit=True, **kwargs):
     """Generate particle velocity animation."""
-
     velocity = sfs.mono.source.pulsating_sphere_velocity(
                omega, center, radius, amplitude, grid)
     phasor = np.exp(1j * 2 * np.pi / frames)
@@ -56,7 +54,6 @@ def sound_pressure(omega, center, radius, amplitude, grid, frames,
                    pulsate=False, figsize=(8, 8), interval=80, blit=True,
                    **kwargs):
     """Generate sound pressure animation."""
-
     pressure = sfs.mono.source.pulsating_sphere(
             omega, center, radius, amplitude, grid, inside=pulsate)
     phasor = np.exp(1j * 2 * np.pi / frames)
