Merge pull request #125 from jnothman/importmatplotlib

Support 'from matplotlib import' as alias for 'import matplotlib'

Author: pv

doc/install.rst

@@ -19,7 +19,7 @@ The following options can be set in your Sphinx ``conf.py``:
 
 numpydoc_use_plots : bool
   Whether to produce ``plot::`` directives for Examples sections that
-  contain ``import matplotlib``.
+  contain ``import matplotlib`` or ``from matplotlib import``.
 numpydoc_show_class_members : bool
   Whether to show all members of a class in the Methods and Attributes
   sections automatically.

numpydoc/docscrape_sphinx.py

@@ -21,6 +21,9 @@
     sixu = lambda s: unicode(s, 'unicode_escape')
 
 
+IMPORT_MATPLOTLIB_RE = r'\b(import +matplotlib|from +matplotlib +import)\b'
+
+
 class SphinxDocString(NumpyDocString):
     def __init__(self, docstring, config={}):
         NumpyDocString.__init__(self, docstring, config=config)
@@ -321,7 +324,7 @@ def _str_references(self):
     def _str_examples(self):
         examples_str = "\n".join(self['Examples'])
 
-        if (self.use_plots and 'import matplotlib' in examples_str
+        if (self.use_plots and re.search(IMPORT_MATPLOTLIB_RE, examples_str)
                 and 'plot::' not in examples_str):
             out = []
             out += self._str_header('Examples')

numpydoc/tests/test_docscrape.py

@@ -832,6 +832,15 @@ def test_plot_examples():
     """, config=cfg)
     assert 'plot::' in str(doc), str(doc)
 
+    doc = SphinxDocString("""
+    Examples
+    --------
+    >>> from matplotlib import pyplot as plt
+    >>> plt.plot([1,2,3],[4,5,6])
+    >>> plt.show()
+    """, config=cfg)
+    assert 'plot::' in str(doc), str(doc)
+
     doc = SphinxDocString("""
     Examples
     --------