Merge pull request #12322 from anntzer/wxless-docs

jklymak · web-flow · commit 2ec59bdb4325 · 2018-09-28T08:39:51.000-07:00
Fix the docs build.
diff --git a/doc/api/backend_wxagg_api.rst b/doc/api/backend_wxagg_api.rst
@@ -2,7 +2,9 @@
 :mod:`matplotlib.backends.backend_wxagg`
 ========================================
 
-.. automodule:: matplotlib.backends.backend_wxagg
-   :members:
-   :undoc-members:
-   :show-inheritance:
+**NOTE** Not included, to avoid adding a dependency to building the docs.
+
+.. .. automodule:: matplotlib.backends.backend_wxagg
+..    :members:
+..    :undoc-members:
+..    :show-inheritance:
diff --git a/doc/sphinxext/mock_gui_toolkits.py b/doc/sphinxext/mock_gui_toolkits.py
@@ -6,23 +6,8 @@ class MyCairoCffi(MagicMock):
     __name__ = "cairocffi"
 
 
-class MyWX(MagicMock):
-    class Panel(object):
-        pass
-
-    class ToolBar(object):
-        pass
-
-    class Frame(object):
-        pass
-
-    class StatusBar(object):
-        pass
-
-
 def setup(app):
     sys.modules.update(
         cairocffi=MyCairoCffi(),
-        wx=MyWX(),
     )
     return {'parallel_read_safe': True, 'parallel_write_safe': True}
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -18,7 +18,7 @@
 import numpy as np
 
 from matplotlib import rcParams
-from matplotlib import docstring
+from matplotlib import backends, docstring
 from matplotlib import __version__ as _mpl_version
 from matplotlib import get_backend
 
@@ -415,12 +415,8 @@ def show(self, warn=True):
         Parameters
         ----------
         warn : bool
-            If ``True``, issue warning when called on a non-GUI backend
-
-        Notes
-        -----
-        For non-GUI backends, this does nothing, in which case a warning will
-        be issued if *warn* is ``True`` (default).
+            If ``True`` and we are not running headless (i.e. on Linux with an
+            unset DISPLAY), issue warning when called on a non-GUI backend.
         """
         try:
             manager = getattr(self.canvas, 'manager')
@@ -436,7 +432,8 @@ def show(self, warn=True):
                 return
             except NonGuiException:
                 pass
-        if warn:
+        if (backends._get_running_interactive_framework() != "headless"
+                and warn):
             warnings.warn('Matplotlib is currently using %s, which is a '
                           'non-GUI backend, so cannot show the figure.'
                           % get_backend())
