FIX: Remove newlines from title (#669)

larsoner · web-flow · commit 96b5fed68a03 · 2020-04-30T13:50:42.000-04:00
diff --git a/examples/plot_1_exp.py b/examples/plot_1_exp.py
@@ -35,7 +35,7 @@ def main():
     plt.plot(x, -np.exp(-x))
     plt.xlabel('$x$')
     plt.ylabel('$-\exp(-x)$')
-    plt.title('Negative exponential function')
+    plt.title('Negative exponential\nfunction')
     # To avoid matplotlib text output
     plt.show()
 
diff --git a/sphinx_gallery/scrapers.py b/sphinx_gallery/scrapers.py
@@ -310,6 +310,7 @@ def figure_rst(figure_list, sources_dir, fig_titles=''):
         # replace - & _ with \s
         file_name_final = re.sub(r'[-,_]', ' ', file_name_noext)
         alt = file_name_final
+    alt = _single_line_sanitize(alt)
 
     images_rst = ""
     if len(figure_paths) == 1:
@@ -322,6 +323,13 @@ def figure_rst(figure_list, sources_dir, fig_titles=''):
     return images_rst
 
 
+def _single_line_sanitize(s):
+    """Remove problematic newlines."""
+    # For example, when setting a :alt: for an image, it shouldn't have \n
+    # This is a function in case we end up finding other things to replace
+    return s.replace('\n', ' ')
+
+
 # The following strings are used when we have several pictures: we use
 # an html div tag that our CSS uses to turn the lists into horizontal
 # lists.
diff --git a/sphinx_gallery/tests/tinybuild/examples/plot_matplotlib_alt.py b/sphinx_gallery/tests/tinybuild/examples/plot_matplotlib_alt.py
@@ -14,7 +14,7 @@
 axs[0].set_title('subplot 1')
 axs[0].set_xlabel('x label')
 axs[0].set_ylabel('y lab')
-fig.suptitle('This is a sup title')
+fig.suptitle('This is a\nsup title')
 
 axs[1].plot([2, 3, 4])
 axs[1].set_title('subplot 2')
