DOC: Start to document interactive figures

doc/api/blocking_input_api.rst

@@ -3,6 +3,6 @@
 *****************************
 
 .. automodule:: matplotlib.blocking_input
-   :members:
-   :undoc-members:
+   :no-members:
+   :no-undoc-members:
    :show-inheritance:

doc/conf.py

@@ -114,13 +114,14 @@ def _check_dependencies():
 missing_references_warn_unused_ignores = False
 
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3', None),
+    'Pillow': ('https://pillow.readthedocs.io/en/stable/', None),
     'cycler': ('https://matplotlib.org/cycler', None),
     'dateutil': ('https://dateutil.readthedocs.io/en/stable/', None),
+    'ipykernel': ('https://ipykernel.readthedocs.io/en/latest/', None),
     'numpy': ('https://docs.scipy.org/doc/numpy/', None),
     'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
-    'Pillow': ('https://pillow.readthedocs.io/en/stable/', None),
     'pytest': ('https://pytest.org/en/stable', None),
+    'python': ('https://docs.python.org/3', None),
     'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
 }
 

doc/devel/documenting_mpl.rst

@@ -304,12 +304,12 @@ Including figures and files
 ---------------------------
 
 Image files can directly included in pages with the ``image::`` directive.
-e.g., :file:`users/navigation_toolbar.rst` displays the toolbar icons
-with a call to a static image::
+e.g., :file:`thirdpartypackages/index.rst` displays the images for the third-party
+packages as static images::
 
-    .. image:: ../_static/toolbar.png
+    .. image:: /_static/toolbar.png
 
-as rendered on the page: :ref:`navigation-toolbar`.
+as rendered on the page: :ref:`thirdparty-index`.
 
 Files can be included verbatim.  For instance the ``matplotlibrc`` file
 is important for customizing Matplotlib, and is included verbatim in the

doc/missing-references.json

@@ -1,4 +1,10 @@
 {
+  "c:var": {
+    "PyOS_InputHook": [
+      "doc/users/interactive_guide.rst:401",
+      "doc/users/interactive_guide.rst:411"
+    ]
+  },
   "py:attr": {
     "ax": [
       "lib/mpl_toolkits/axes_grid1/colorbar.py:docstring of mpl_toolkits.axes_grid1.colorbar.ColorbarBase:23"
@@ -453,6 +459,9 @@
     "FigureCanvasQTAgg.print_figure": [
       "doc/api/prev_api_changes/api_changes_2.2.0.rst:199"
     ],
+    "IPython.terminal.interactiveshell.TerminalInteractiveShell.inputhook": [
+      "doc/users/interactive_guide.rst:428"
+    ],
     "_find_tails": [
       "lib/matplotlib/quiver.py:docstring of matplotlib.quiver.Barbs:9"
     ],
@@ -521,6 +530,9 @@
     ]
   },
   "py:mod": {
+    "IPython.terminal.pt_inputhooks": [
+      "doc/users/interactive_guide.rst:428"
+    ],
     "dateutil": [
       "lib/matplotlib/dates.py:docstring of matplotlib.dates:1"
     ],
@@ -562,6 +574,9 @@
     "./gallery/index.html": [
       "doc/devel/contributing.rst:562"
     ],
+    "Artist.stale_callback": [
+      "doc/users/interactive_guide.rst:326"
+    ],
     "Artist.sticky_edges": [
       "doc/api/axes_api.rst:362:<autosummary>:1",
       "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.use_sticky_edges:2"
@@ -640,6 +655,9 @@
       "doc/gallery/misc/ftface_props.rst:16",
       "lib/matplotlib/font_manager.py:docstring of matplotlib.font_manager.ttfFontProperty:8"
     ],
+    "Figure.stale_callback": [
+      "doc/users/interactive_guide.rst:336"
+    ],
     "FigureCanvas": [
       "lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolBase:25"
     ],
@@ -966,6 +984,9 @@
     "invert_yaxis": [
       "lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.get_ylim3d:24"
     ],
+    "ipykernel.pylab.backend_inline": [
+      "doc/users/interactive.rst:249"
+    ],
     "kde.covariance_factor": [
       "lib/matplotlib/mlab.py:docstring of matplotlib.mlab.GaussianKDE:41"
     ],