Refactor fix thumbnails. (#347)

* Rename gallery_generator to thumbnail_extractor. Add debug output. Write thumbnails to separate directory.

* Fix relative path issues.

* Fix path issues.

* Add _thumbnails to .gitignore.

Author: twiecki

.gitignore

@@ -5,3 +5,4 @@
 
 _build
 jupyter_execute
+_thumbnails

_thumbnails/thumbnails/README.txt

@@ -0,0 +1 @@
+Thumbnails will automatically be generated an placed in this directory by the thumbnail_extractor.py script.

examples/conf.py

@@ -25,7 +25,7 @@
     "sphinx_codeautolink",
     "notfound.extension",
     "sphinx_gallery.load_style",
-    "gallery_generator",
+    "thumbnail_extractor",
 ]
 
 # List of patterns, relative to source directory, that match files and
@@ -54,13 +54,13 @@ def hack_nbsphinx(app: Sphinx) -> None:
 
     from glob import glob
 
-    nb_paths = glob("examples/*/*.ipynb")
+    nb_paths = glob("*/*.ipynb")
     nbsphinx_thumbnails = {}
     for nb_path in nb_paths:
-        png_file = os.path.join("_static", os.path.splitext(os.path.split(nb_path)[-1])[0] + ".png")
-        nb_path_rel = os.path.splitext(
-            os.path.join(*os.path.normpath(nb_path).split(os.path.sep)[1:])
-        )[0]
+        png_file = os.path.join(
+            "thumbnails", os.path.splitext(os.path.split(nb_path)[-1])[0] + ".png"
+        )
+        nb_path_rel = os.path.splitext(nb_path)[0]
         nbsphinx_thumbnails[nb_path_rel] = png_file
 
     def builder_inited(app: Sphinx):
@@ -145,7 +145,8 @@ def setup(app: Sphinx):
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["../_static", "../_images", "../_templates"]
+html_static_path = ["../_static"]
+html_extra_path = ["../_thumbnails"]
 html_css_files = ["custom.css"]
 templates_path = ["../_templates"]
 html_sidebars = {

sphinxext/gallery_generator.py renamed to sphinxext/thumbnail_extractor.py

@@ -15,8 +15,12 @@
 
 from matplotlib import image
 
-DOC_SRC = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
-DEFAULT_IMG_LOC = os.path.join(os.path.dirname(DOC_SRC), "pymc-examples/_static", "PyMC.png")
+import sphinx
+
+logger = sphinx.util.logging.getLogger(__name__)
+
+DOC_SRC = os.path.dirname(os.path.abspath(__file__))
+DEFAULT_IMG_LOC = os.path.join(os.path.dirname(DOC_SRC), "_static", "PyMC.png")
 
 
 def create_thumbnail(infile, width=275, height=275, cx=0.5, cy=0.5, border=4):
@@ -52,7 +56,7 @@ class NotebookGenerator:
     def __init__(self, filename, target_dir):
         self.basename = os.path.basename(filename)
         stripped_name = os.path.splitext(self.basename)[0]
-        self.image_dir = os.path.join(target_dir, "_static")
+        self.image_dir = os.path.join(target_dir, "_thumbnails", "thumbnails")
         self.png_path = os.path.join(self.image_dir, f"{stripped_name}.png")
         with open(filename) as fid:
             self.json_source = json.load(fid)
@@ -75,18 +79,21 @@ def gen_previews(self):
             with open(self.png_path, "wb") as buff:
                 buff.write(preview)
         else:
-            print(f"didn't find for {self.png_path}")
+            logger.warning(
+                f"Didn't find any pictures in {self.basename}", type="thumbnail_extractor"
+            )
             shutil.copy(self.default_image_loc, self.png_path)
         create_thumbnail(self.png_path)
 
 
 def main(app):
+    logger.info("Starting thumbnail extractor.")
     from glob import glob
 
-    nb_paths = glob("examples/*/*.ipynb")
+    nb_paths = glob("*/*.ipynb")
 
     for nb_path in nb_paths:
-        nbg = NotebookGenerator(nb_path, "")
+        nbg = NotebookGenerator(nb_path, "..")
         nbg.gen_previews()