Document directives, fix brittle paths in gallery item directive

chsasank · chsasank · commit e925369ccc84 · 2017-04-22T10:35:14.000+05:30
diff --git a/conf.py b/conf.py
@@ -63,7 +63,7 @@
     # Create gallery dirs if it doesn't exist
     try:
         os.mkdir(gallery_dir)
-    except FileExistsError:
+    except OSError:
         pass
 
     # Copy rst files from source dir to gallery dir
diff --git a/custom_directives.py b/custom_directives.py
@@ -5,7 +5,23 @@
 import os
 import sphinx_gallery
 
+try:
+    FileNotFoundError
+except NameError:
+    FileNotFoundError = IOError
+
+
 class IncludeDirective(Directive):
+    """Include source file without docstring at the top of file.
+
+    Implementation just replaces the first docstring found in file
+    with '' once.
+
+    Example usage:
+
+    .. includenodoc:: /beginner/examples_tensor/two_layer_net_tensor.py
+
+    """
 
     # defines the parameter the directive expects
     # directives.unchanged means you get the raw value from RST
@@ -35,6 +51,22 @@ def run(self):
 
 
 class GalleryItemDirective(Directive):
+    """
+    Create a sphinx gallery thumbnail for insertion anywhere in docs.
+
+    Optionally, you can specify the custom figure and intro/tooltip for the
+    thumbnail.
+
+    Example usage:
+
+    .. galleryitem:: intermediate/char_rnn_generation_tutorial.py
+        :figure: _static/img/char_rnn_generation.png
+        :intro: Put your custom intro here.
+
+    If figure is specified, a thumbnail will be made out of it and stored in
+    _static/thumbs. Therefore, consider _static/thumbs as a 'built' directory.
+    """
+
     required_arguments = 1
     optional_arguments = 0
     final_argument_whitespace = True
@@ -46,28 +78,34 @@ class GalleryItemDirective(Directive):
     def run(self):
         args = self.arguments
         fname = args[-1]
+
+        env = self.state.document.settings.env
+        fname, abs_fname = env.relfn2path(fname)
         basename = os.path.basename(fname)
         dirname = os.path.dirname(fname)
 
         try:
             if 'intro' in self.options:
                 intro = self.options['intro'][:195] + '...'
             else:
-                intro = sphinx_gallery.gen_rst.extract_intro(fname)
+                intro = sphinx_gallery.gen_rst.extract_intro(abs_fname)
 
-            thumbnail_rst = sphinx_gallery.backreferences._thumbnail_div(dirname, basename, intro)
+            thumbnail_rst = sphinx_gallery.backreferences._thumbnail_div(
+                dirname, basename, intro)
 
             if 'figure' in self.options:
-                env = self.state.document.settings.env
                 rel_figname, figname = env.relfn2path(self.options['figure'])
-                save_figname = os.path.join('_static/thumbs/', os.path.basename(figname))
+                save_figname = os.path.join('_static/thumbs/',
+                                            os.path.basename(figname))
 
                 try:
                     os.makedirs('_static/thumbs')
-                except FileExistsError:
+                except OSError:
                     pass
 
-                sphinx_gallery.gen_rst.scale_image(figname, save_figname, 400, 280)
+                sphinx_gallery.gen_rst.scale_image(figname, save_figname,
+                                                   400, 280)
+                # replace figure in rst with simple regex
                 thumbnail_rst = re.sub(r'..\sfigure::\s.*\.png',
                                        '.. figure:: /{}'.format(save_figname),
                                        thumbnail_rst)
@@ -82,7 +120,6 @@ def run(self):
             return []
 
 
-
 GALLERY_TEMPLATE = """
 .. raw:: html
 
@@ -99,7 +136,24 @@ def run(self):
     </div>
 """
 
+
 class CustomGalleryItemDirective(Directive):
+    """Create a sphinx gallery style thumbnail.
+
+    tooltip and figure are self explanatory. Description could be a link to
+    a document like in below example. 
+
+    Example usage:
+
+    .. customgalleryitem::
+        :tooltip: I am writing this tutorial to focus specifically on NLP for people who have never written code in any deep learning framework
+        :figure: /_static/img/thumbnails/babel.jpg
+        :description: :doc:`/beginner/deep_learning_nlp_tutorial`
+
+    If figure is specified, a thumbnail will be made out of it and stored in
+    _static/thumbs. Therefore, consider _static/thumbs as a 'built' directory.
+    """
+
     required_arguments = 0
     optional_arguments = 0
     final_argument_whitespace = True
diff --git a/requirements.txt b/requirements.txt
@@ -4,3 +4,4 @@ sphinx-gallery
 numpy
 matplotlib
 torchvision
+torch
