Skip to content

Commit 0ae666b

Browse files
timhoffmtimhoffm
authored
Merge pull request #21835 from QuLogic/interactive-docs
Small improvements to interactive examples
2 parents 168c8b9 + 8fb7f0f commit 0ae666b

21 files changed

+289
-116
lines changed

‎examples/animation/pause_resume.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@
77
88
- using the Animation.pause() method to pause an animation.
99
- using the Animation.resume() method to resume an animation.
10+
11+
.. note::
12+
This example exercises the interactive capabilities of Matplotlib, and this
13+
will not appear in the static documentation. Please run this code on your
14+
machine to see the interactivity.
15+
16+
You can copy and paste individual parts, or download the entire example
17+
using the link at the bottom of the page.
1018
"""
1119

1220
import matplotlib.pyplot as plt

‎examples/event_handling/close_event.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@
44
===========
55
66
Example to show connecting events that occur when the figure closes.
7+
8+
.. note::
9+
This example exercises the interactive capabilities of Matplotlib, and this
10+
will not appear in the static documentation. Please run this code on your
11+
machine to see the interactivity.
12+
13+
You can copy and paste individual parts, or download the entire example
14+
using the link at the bottom of the page.
715
"""
816
import matplotlib.pyplot as plt
917

‎examples/event_handling/coords_demo.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@
55
66
An example of how to interact with the plotting canvas by connecting to move
77
and click events.
8+
9+
.. note::
10+
This example exercises the interactive capabilities of Matplotlib, and this
11+
will not appear in the static documentation. Please run this code on your
12+
machine to see the interactivity.
13+
14+
You can copy and paste individual parts, or download the entire example
15+
using the link at the bottom of the page.
816
"""
917

1018
from matplotlib.backend_bases import MouseButton

‎examples/event_handling/data_browser.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@
88
This example covers how to interact data with multiple canvases. This
99
let's you select and highlight a point on one axis, and generating the
1010
data of that point on the other axis.
11+
12+
.. note::
13+
This example exercises the interactive capabilities of Matplotlib, and this
14+
will not appear in the static documentation. Please run this code on your
15+
machine to see the interactivity.
16+
17+
You can copy and paste individual parts, or download the entire example
18+
using the link at the bottom of the page.
1119
"""
1220
import numpy as np
1321

‎examples/event_handling/figure_axes_enter_leave.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@
55
66
Illustrate the figure and Axes enter and leave events by changing the
77
frame colors on enter and leave.
8+
9+
.. note::
10+
This example exercises the interactive capabilities of Matplotlib, and this
11+
will not appear in the static documentation. Please run this code on your
12+
machine to see the interactivity.
13+
14+
You can copy and paste individual parts, or download the entire example
15+
using the link at the bottom of the page.
816
"""
917
import matplotlib.pyplot as plt
1018

‎examples/event_handling/ginput_manual_clabel_sgskip.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,13 @@
66
This provides examples of uses of interactive functions, such as ginput,
77
waitforbuttonpress and manual clabel placement.
88
9-
This script must be run interactively using a backend that has a
10-
graphical user interface (for example, using GTK3Agg backend, but not
11-
PS backend).
9+
.. note::
10+
This example exercises the interactive capabilities of Matplotlib, and this
11+
will not appear in the static documentation. Please run this code on your
12+
machine to see the interactivity.
1213
14+
You can copy and paste individual parts, or download the entire example
15+
using the link at the bottom of the page.
1316
"""
1417

1518
import time

‎examples/event_handling/image_slices_viewer.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@
44
===================
55
66
Scroll through 2D image slices of a 3D array.
7+
8+
.. note::
9+
This example exercises the interactive capabilities of Matplotlib, and this
10+
will not appear in the static documentation. Please run this code on your
11+
machine to see the interactivity.
12+
13+
You can copy and paste individual parts, or download the entire example
14+
using the link at the bottom of the page.
715
"""
816

917
import numpy as np

‎examples/event_handling/keypress_demo.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@
44
==============
55
66
Show how to connect to keypress events.
7+
8+
.. note::
9+
This example exercises the interactive capabilities of Matplotlib, and this
10+
will not appear in the static documentation. Please run this code on your
11+
machine to see the interactivity.
12+
13+
You can copy and paste individual parts, or download the entire example
14+
using the link at the bottom of the page.
715
"""
816
import sys
917
import numpy as np

‎examples/event_handling/lasso_demo.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@
99
1010
This is currently a proof-of-concept implementation (though it is
1111
usable as is). There will be some refinement of the API.
12+
13+
.. note::
14+
This example exercises the interactive capabilities of Matplotlib, and this
15+
will not appear in the static documentation. Please run this code on your
16+
machine to see the interactivity.
17+
18+
You can copy and paste individual parts, or download the entire example
19+
using the link at the bottom of the page.
1220
"""
1321

1422
from matplotlib import colors as mcolors, path

‎examples/event_handling/legend_picking.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@
44
==============
55
66
Enable picking on the legend to toggle the original line on and off
7+
8+
.. note::
9+
This example exercises the interactive capabilities of Matplotlib, and this
10+
will not appear in the static documentation. Please run this code on your
11+
machine to see the interactivity.
12+
13+
You can copy and paste individual parts, or download the entire example
14+
using the link at the bottom of the page.
715
"""
816

917
import numpy as np

‎examples/event_handling/looking_glass.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@
44
=============
55
66
Example using mouse events to simulate a looking glass for inspecting data.
7+
8+
.. note::
9+
This example exercises the interactive capabilities of Matplotlib, and this
10+
will not appear in the static documentation. Please run this code on your
11+
machine to see the interactivity.
12+
13+
You can copy and paste individual parts, or download the entire example
14+
using the link at the bottom of the page.
715
"""
816
import numpy as np
917
import matplotlib.pyplot as plt

‎examples/event_handling/path_editor.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@
77
88
This example demonstrates a cross-GUI application using Matplotlib event
99
handling to interact with and modify objects on the canvas.
10+
11+
.. note::
12+
This example exercises the interactive capabilities of Matplotlib, and this
13+
will not appear in the static documentation. Please run this code on your
14+
machine to see the interactivity.
15+
16+
You can copy and paste individual parts, or download the entire example
17+
using the link at the bottom of the page.
1018
"""
1119

1220
import numpy as np

0 commit comments

Comments
 (0)