Merge pull request #114 from FourierFlows/adddocswarning

Animations in Docs don't show up in Safari
FourierFlows · Sep 18, 2020 · 18dd9c0 · 18dd9c0 · navidcy · Sep 18, 2020
2 parents ea99ce0 + 30fa1ec
commit 18dd9c0
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -6,6 +6,15 @@
 [FourierFlows.jl](https://github.com/FourierFlows/FourierFlows.jl) framework to provide
 solvers for problems in Geophysical Fluid Dynamics, on periodic domains and using Fourier-based pseudospectral methods.
 
+## Examples
+
+Examples aim to demonstrate the main functionalities of each module. Have a look at our Examples collection!
+
+!!! warning "Animations and Mac OS X Safari"
+    Often animations included the documentation, e.g., those in the [2D Navier-Stokes decaying turbulence example](generated/twodnavierstokes_decaying/)
+    don't show up in Safari. Until this issue is fixed we suggest using alternative browsers 
+    to view the documentation.
+
 ## Developers
 
 GeophysicalFlows is currently being developed by [Navid C. Constantinou](http://www.navidconstantinou.com) and [Gregory L. Wagner](https://glwagner.github.io).