added image_* directive options

Author: tikuma-lsuhsc

README.rst

@@ -314,3 +314,21 @@ Example of directive options:
       plt.plot(np.random.randn(100))
       plt.title('plotted in repl-quiet')
       plt.show()
+
+Image Options
+^^^^^^^^^^^^^
+
+All of the options of the ``image`` directive, except for ``target`` (since target 
+image is generated by the REPL process). Currently, these options applies to the
+Matplotlib figure images.
+
+==================  ===========
+Directive           Description
+==================  ===========
+``:image_alt:``     Alternate text: a short description of the image
+``:image_height:``  The desired height of the image
+``:image_width:``   The width of the image
+``:image_scale:``   The uniform scaling factor of the image
+``:image_align:``   The alignment of the image
+``:image_class:``   Set a "classes" attribute value on the doctree element generated by the directive
+==================  ===========

src/sphinxcontrib/repl/__init__.py

@@ -247,8 +247,7 @@ def kill_all(*_):
     repl_procs.clear()
 
 
-def create_image(document, line):
-    # TODO : support image options
+def create_image(document, line, image_options):
     imgpath = line[10:]
     confdir = document.settings.env.app.confdir  # source root
     rst_file = document.attributes["source"]  # source file path
@@ -258,14 +257,15 @@ def create_image(document, line):
     )
     img_relpath = os.path.relpath(imgpath, rst_outdir)
     uri = directives.uri(img_relpath.replace("\\", "/"))
-    return nodes.image(line, uri=uri)
+    return nodes.image(line, uri=uri, **image_options)
 
 
-def create_mpl_container_node(document, lines):
+def create_mpl_container_node(document, lines, options):
+    image_options = {k[6:]: v for k, v in options.items() if k.startswith("image_")}
     return nodes.container(
         "",
         *(
-            create_image(document, line)
+            create_image(document, line, image_options)
             for line in lines
             if line.startswith("#repl:img:")
         ),
@@ -368,6 +368,7 @@ class REPL(Directive):
         "hide-input": _option_boolean,
         "hide-output": _option_boolean,
         **create_mpl_option_spec(),
+        **create_image_option_spec(),
     }
 
     def run(self):
@@ -403,7 +404,9 @@ def run(self):
         def to_node(block):
             if block[0].startswith("#repl:img:"):
                 # generated new image
-                return create_mpl_container_node(self.state_machine.document, lines)
+                return create_mpl_container_node(
+                    self.state_machine.document, lines, self.options
+                )
             else:
                 s = "\n".join(block)
                 return nodes.doctest_block(s, s, language="python")
@@ -415,7 +418,7 @@ class REPL_Quiet(Directive):
     has_content = True
     required_arguments = 0
     optional_arguments = 0
-    option_spec = create_mpl_option_spec()
+    option_spec = {**create_mpl_option_spec(), **create_image_option_spec()}
 
     def run(self):
         # dump the content on REPL & ignore what's printed on the interpreter
@@ -430,7 +433,9 @@ def run(self):
         lines = proc.communicate(self.content, show_input=False, show_output=False)
 
         # only return the image lines
-        return [create_mpl_container_node(self.state_machine.document, lines)]
+        return [
+            create_mpl_container_node(self.state_machine.document, lines, self.options)
+        ]
 
 
 def mpl_init(app, config):

tests/roots/test-root/index.rst

@@ -54,6 +54,7 @@ With ``repl-quiet`` directive, only the plotted figures are shown:
    :mpl_pad_inches:  0.1
    :mpl_transparent:  False
    :mpl_rc_params:  {"lines.marker": "x", "lines.markersize": 3}
+   :image_width: 50%
 
    plt.plot(np.random.randn(100))
    plt.title('plotted in repl-quiet')