Merge pull request #26474 from story645/sphinx-conf

timhoffm · web-flow · commit 4a80a41ff6cb · 2023-08-09T15:55:38.000+02:00
[DOC]: filter non-gui backend warnings when building docs
diff --git a/doc/conf.py b/doc/conf.py
@@ -160,8 +160,9 @@ def _check_dependencies():
 # The following import is only necessary to monkey patch the signature later on
 from sphinx_gallery import gen_rst
 
-# On Linux, prevent plt.show() from emitting a non-GUI backend warning.
-os.environ.pop("DISPLAY", None)
+# Prevent plt.show() from emitting a non-GUI backend warning.
+warnings.filterwarnings('ignore', category=UserWarning,
+                        message=r'(\n|.)*is non-interactive, and thus cannot be shown')
 
 autosummary_generate = True
 autodoc_typehints = "none"
