improve the doc building

doc/installation.rst

@@ -96,14 +96,19 @@ To build this documentation, some modules are required:
     pip install "sphinx_rtd_theme>1"
     pip install pillow==9.0.0
 
+If you plan to build the interaction examples, you'll need to download this link:
+
+.. todo:: ADD LINK TO THE BIG DATA REPO
+
+and define an environment variable ``MSNOISE_DOC`` with the path to where that data has been extracted.
 
 Then, this should simply work:
 
 .. code-block:: sh
 
     make html
     
-it will create a .build folder containing the documentation.
+it will create a .build/html folder containing the documentation.
 
 You can also build the doc to Latex and then use your favorite Latex-to-PDF
 tool.

examples/plot_compute_hvsr.py

@@ -9,8 +9,9 @@
 # Import & getting the data from the computed autocorrelations (ZZ, EE, NN)
 
 import os
-if "SPHINX_DOC_BUILD" in os.environ or 1:
-    os.chdir(r"C:\tmp\MSNOISE_DOC")
+if "SPHINX_DOC_BUILD" in os.environ:
+    if "MSNOISE_DOC" in os.environ:
+        os.chdir(os.environ["MSNOISE_DOC"])
 
 import matplotlib
 matplotlib.use("agg")

examples/plot_compute_hvsr_psd.py

@@ -13,8 +13,9 @@
 
 import os
 
-if "SPHINX_DOC_BUILD" in os.environ or 1:
-    os.chdir(r"C:\tmp\MSNOISE_DOC")
+if "SPHINX_DOC_BUILD" in os.environ:
+    if "MSNOISE_DOC" in os.environ:
+        os.chdir(os.environ["MSNOISE_DOC"])
 
 import matplotlib
 # matplotlib.use("agg")

examples/plot_interferogram.py

@@ -6,8 +6,9 @@
 """
 
 import os
-if "SPHINX_DOC_BUILD" in os.environ or 1:
-    os.chdir(r"C:\tmp\MSNOISE_DOC")
+if "SPHINX_DOC_BUILD" in os.environ:
+    if "MSNOISE_DOC" in os.environ:
+        os.chdir(os.environ["MSNOISE_DOC"])
 
 import matplotlib
 matplotlib.use("agg")
@@ -55,8 +56,9 @@
 #############################################################
 # Plotting the sub-daily stacks and zooming on +- 20 seconds:
 
-if "SPHINX_DOC_BUILD" in os.environ or 1:
-    os.chdir(r"C:\tmp\MSNOISE_DOC")
+if "SPHINX_DOC_BUILD" in os.environ:
+    if "MSNOISE_DOC" in os.environ:
+        os.chdir(os.environ["MSNOISE_DOC"])
 
 # Get the last mov_stack configured:
 mov_stack = params.mov_stack[-1]