DOC: Suppress IPython output in examples and tutorials where not needed

StefRe · StefRe · commit 23d9b03861d1 · 2022-09-21T18:12:04.000+02:00
By default, sphinx-gallery captures the last output of each code block
and shows it in the generated html in yellow boxes. Especially in
tutorials with a frequently interleaving code and text blocks this may
appear confusing and reduces readability. In some cases, however, the
output is desired (although it could always be replaced by printing).

The global configuration is now changed to "capture nothing", for one
tutorial with multiple desired outputs this is overridden in the file
to show the output and in other cases with just one desired output
it's converted to a call to print().
diff --git a/doc/conf.py b/doc/conf.py
@@ -199,6 +199,7 @@ def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf,
     'subsection_order': gallery_order.sectionorder,
     'thumbnail_size': (320, 224),
     'within_subsection_order': gallery_order.subsectionorder,
+    'capture_repr': (),
 }
 
 if 'plot_gallery=0' in sys.argv:
diff --git a/tutorials/intermediate/artists.py b/tutorials/intermediate/artists.py
@@ -115,6 +115,7 @@ class in the Matplotlib API, and the one you will be working with most
 
 Try creating the figure below.
 """
+# sphinx_gallery_capture_repr = ('__repr__',)
 
 import numpy as np
 import matplotlib.pyplot as plt
diff --git a/tutorials/intermediate/autoscale.py b/tutorials/intermediate/autoscale.py
@@ -26,7 +26,7 @@
 # -------
 # The default margin around the data limits is 5%:
 
-ax.margins()
+print(ax.margins())
 
 ###############################################################################
 # The margins can be made larger using `~matplotlib.axes.Axes.margins`:

Original file line number	Diff line number	Diff line change
`@@ -199,6 +199,7 @@ def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf,`
`199`	`199`	`'subsection_order': gallery_order.sectionorder,`
`200`	`200`	`'thumbnail_size': (320, 224),`
`201`	`201`	`'within_subsection_order': gallery_order.subsectionorder,`
	`202`	`+ 'capture_repr': (),`
`202`	`203`	`}`
`203`	`204`
`204`	`205`	`if 'plot_gallery=0' in sys.argv:`