Merge pull request #4702 from hamogu/fix_4702

mdboom · mdboom · commit f3e2fa1d309a · 2015-12-08T12:05:31.000-05:00
sphinxext/plot_directive does not accept a caption
diff --git a/lib/matplotlib/sphinxext/plot_directive.py b/lib/matplotlib/sphinxext/plot_directive.py
@@ -662,10 +662,6 @@ def render_figures(code, code_path, output_dir, output_base, context,
 
 
 def run(arguments, content, options, state_machine, state, lineno):
-    # The user may provide a filename *or* Python code content, but not both
-    if arguments and content:
-        raise RuntimeError("plot:: directive can't have both args and content")
-
     document = state_machine.document
     config = document.settings.env.config
     nofigs = 'nofigs' in options
diff --git a/lib/matplotlib/sphinxext/tests/test_tinypages.py b/lib/matplotlib/sphinxext/tests/test_tinypages.py
@@ -83,3 +83,8 @@ def plot_file(num):
         with open(pjoin(self.html_dir, 'some_plots.html'), 'rt') as fobj:
             html_contents = fobj.read()
         assert_true('# Only a comment' in html_contents)
+        # check plot defined in external file.
+        assert_true(file_same(range_4, pjoin(self.html_dir, 'range4.png')))
+        assert_true(file_same(range_6, pjoin(self.html_dir, 'range6.png')))
+        # check if figure caption made it into html file
+        assert_true('This is the caption for plot 15.' in html_contents)
diff --git a/lib/matplotlib/sphinxext/tests/tinypages/range4.py b/lib/matplotlib/sphinxext/tests/tinypages/range4.py
@@ -0,0 +1,5 @@
+from matplotlib import pyplot as plt
+
+plt.figure()
+plt.plot(range(4))
+plt.show()
diff --git a/lib/matplotlib/sphinxext/tests/tinypages/range6.py b/lib/matplotlib/sphinxext/tests/tinypages/range6.py
@@ -0,0 +1,13 @@
+from matplotlib import pyplot as plt
+
+
+def range4():
+    '''This is never be called if plot_directive works as expected.'''
+    raise NotImplementedError
+
+
+def range6():
+    '''This is the function that should be executed.'''
+    plt.figure()
+    plt.plot(range(6))
+    plt.show()
diff --git a/lib/matplotlib/sphinxext/tests/tinypages/some_plots.rst b/lib/matplotlib/sphinxext/tests/tinypages/some_plots.rst
@@ -114,3 +114,16 @@ Plot 14 uses ``include-source``:
     :include-source:
 
     # Only a comment
+
+Plot 15 uses an external file with the plot commands and a caption:
+
+.. plot:: range4.py
+
+   This is the caption for plot 15.
+
+
+Plot 16 uses a specific function in a file with plot commands:
+
+.. plot:: range6.py range6
+
+
