Merge pull request #428 from fziegner/notebooks_thumbnail_fix

Fix missing thumbnails for notebook gallery

doc/conf.py

@@ -19,14 +19,14 @@
     "sphinx_rtd_theme",
     "sphinx.ext.napoleon",
     "nbsphinx",
-   "sphinx_gallery.load_style",
+    "sphinx_gallery.load_style",
 ]
 
 
 html_theme = "sphinx_rtd_theme"
 
 html_static_path = ["_static"]
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 project = "tobac"
 
@@ -79,3 +79,18 @@ def setup(app):
 napoleon_preprocess_types = False
 napoleon_type_aliases = None
 napoleon_attr_annotations = True
+
+nbsphinx_thumbnails = {
+    "examples/Basics/Idealized-Case-1_Tracking-of-a-Test-Blob-in-2D": "_static/thumbnails/Basics_Idealized-Case-1_Tracking-of-a-Test-Blob-in-2D_Thumbnail.png",
+    "examples/Basics/Idealized-Case-2_Two_crossing_Blobs": "_static/thumbnails/Basics_Idealized-Case-2_Two_crossing_Blobs_Thumbnail.png",
+    "examples/Basics/Methods-and-Parameters-for-Feature-Detection_Part_1": "_static/thumbnails/Basics_Methods-and-Parameters-for-Feature-Detection_Part_1_Thumbnail.png",
+    "examples/Basics/Methods-and-Parameters-for-Feature-Detection_Part_2": "_static/thumbnails/Basics_Methods-and-Parameters-for-Feature-Detection_Part_2_Thumbnail.png",
+    "examples/Basics/Methods-and-Parameters-for-Linking": "_static/thumbnails/Basics_Methods-and-Parameters-for-Linking_Thumbnail.png",
+    "examples/Basics/Methods-and-Parameters-for-Segmentation": "_static/thumbnails/Basics_Methods-and-Parameters-for-Segmentation_Thumbnail.png",
+    "examples/Example_OLR_Tracking_model/Example_OLR_Tracking_model": "_static/thumbnails/Example_OLR_Tracking_model_Thumbnail.png",
+    "examples/Example_OLR_Tracking_satellite/Example_OLR_Tracking_satellite": "_static/thumbnails/Example_OLR_Tracking_satellite_Thumbnail.png",
+    "examples/Example_Precip_Tracking/Example_Precip_Tracking": "_static/thumbnails/Example_Precip_Tracking_Thumbnail.png",
+    "examples/Example_Track_on_Radar_Segment_on_Satellite/Example_Track_on_Radar_Segment_on_Satellite": "_static/thumbnails/Example_Track_on_Radar_Segment_on_Satellite_Thumbnail.png",
+    "examples/Example_Updraft_Tracking/Example_Updraft_Tracking": "_static/thumbnails/Example_Updraft_Tracking_Thumbnail.png",
+    "examples/Example_vorticity_tracking_model/Example_vorticity_tracking_model": "_static/thumbnails/Example_vorticity_tracking_model_Thumbnail.png",
+}

doc/examples.rst

@@ -6,30 +6,30 @@ tobac is provided with a set of Jupyter notebooks that show examples of the appl
 .. nbgallery::
    :caption: Fundamentals of Detection and Tracking
 
-   Test Blob in 2D <examples4doc/Basics/Idealized-Case-1_Tracking-of-a-Test-Blob-in-2D>
-   Two crossing Blobs <examples4doc/Basics/Idealized-Case-2_Two_crossing_Blobs.ipynb>
-   
-   On Feature Detection: Part 1 <examples4doc/Basics/Methods-and-Parameters-for-Feature-Detection_Part_1.ipynb> 
-   On Feature Detection: Part 2 <examples4doc/Basics/Methods-and-Parameters-for-Feature-Detection_Part_2.ipynb>
-   On Segmentation <examples4doc/Basics/Methods-and-Parameters-for-Segmentation.ipynb>
-   On Linking <examples4doc/Basics/Methods-and-Parameters-for-Linking.ipynb>  
+   Test Blob in 2D <examples/Basics/Idealized-Case-1_Tracking-of-a-Test-Blob-in-2D>
+   Two crossing Blobs <examples/Basics/Idealized-Case-2_Two_crossing_Blobs.ipynb>
+
+   On Feature Detection: Part 1 <examples/Basics/Methods-and-Parameters-for-Feature-Detection_Part_1.ipynb>
+   On Feature Detection: Part 2 <examples/Basics/Methods-and-Parameters-for-Feature-Detection_Part_2.ipynb>
+   On Segmentation <examples/Basics/Methods-and-Parameters-for-Segmentation.ipynb>
+   On Linking <examples/Basics/Methods-and-Parameters-for-Linking.ipynb>
 
 
 
 
 .. nbgallery::
    :caption: Examples of Using *tobac* with Observations
-   
-   OLR from GOES-13 Satellite <examples4doc/Example_OLR_Tracking_satellite/Example_OLR_Tracking_satellite>
-   Combine Radar & Satellite <examples4doc/Example_Track_on_Radar_Segment_on_Satellite/Example_Track_on_Radar_Segment_on_Satellite>
+
+   OLR from GOES-13 Satellite <examples/Example_OLR_Tracking_satellite/Example_OLR_Tracking_satellite>
+   Combine Radar & Satellite <examples/Example_Track_on_Radar_Segment_on_Satellite/Example_Track_on_Radar_Segment_on_Satellite>
 
 
 .. nbgallery::
    :caption: Examples of Using *tobac* with Model Data
 
-   WRF OLR <examples4doc/Example_OLR_Tracking_model/Example_OLR_Tracking_model>
-   WRF Precip <examples4doc/Example_Precip_Tracking/Example_Precip_Tracking>
-   WRF Updrafts <examples4doc/Example_Updraft_Tracking/Example_Updraft_Tracking>
-   WRF Mesoscale Vorticity <examples4doc/Example_vorticity_tracking_model/Example_vorticity_tracking_model> 
+   WRF OLR <examples/Example_OLR_Tracking_model/Example_OLR_Tracking_model>
+   WRF Precip <examples/Example_Precip_Tracking/Example_Precip_Tracking>
+   WRF Updrafts <examples/Example_Updraft_Tracking/Example_Updraft_Tracking>
+   WRF Mesoscale Vorticity <examples/Example_vorticity_tracking_model/Example_vorticity_tracking_model>
 
-The notebooks can be found in the **examples** folder as part of the python package. The necessary input data for these examples is avaliable on zenodo and can be downloaded automatically by the Jupyter notebooks.
+The notebooks can be found in the **examples** folder as part of the python package. The necessary input data for these examples is avaliable on zenodo and can be downloaded automatically by the Jupyter notebooks.