8000 Merge pull request #4779 from tacaswell/doc_interactive_doc · matplotlib/matplotlib@46936d7 · GitHub
[go: up one dir, main page]
Skip to content

Commit 46936d7

Browse files
QuLogicQuLogic
authored
Merge pull request #4779 from tacaswell/doc_interactive_doc
DOC: Start to document interactive figures
2 parents d132860 + f05ea3d commit 46936d7

File tree

10 files changed

+854
-335
lines changed

10 files changed

+854
-335
lines changed

‎doc/conf.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,14 @@ def _check_dependencies():
111111
missing_references_warn_unused_ignores = False
112112

113113
intersphinx_mapping = {
114-
'python': ('https://docs.python.org/3', None),
114+
'Pillow': ('https://pillow.readthedocs.io/en/stable/', None),
115115
'cycler': ('https://matplotlib.org/cycler', None),
116116
'dateutil': ('https://dateutil.readthedocs.io/en/stable/', None),
117+
'ipykernel': ('https://ipykernel.readthedocs.io/en/latest/', None),
117118
'numpy': ('https://docs.scipy.org/doc/numpy/', None),
118119
'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
119-
'Pillow': ('https://pillow.readthedocs.io/en/stable/', None),
120120
'pytest': ('https://pytest.org/en/stable', None),
121+
'python': ('https://docs.python.org/3', None),
121122
'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
122123
}
123124

‎doc/devel/documenting_mpl.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -304,12 +304,12 @@ Including figures and files
304304
---------------------------
305305

306306
Image files can directly included in pages with the ``image::`` directive.
307-
e.g., :file:`users/navigation_toolbar.rst` displays the toolbar icons
308-
with a call to a static image::
307+
e.g., :file:`thirdpartypackages/index.rst` displays the images for the third-party
308+
packages as static images::
309309

310-
.. image:: ../_static/toolbar.png
310+
.. image:: /_static/toolbar.png
311311

312-
as rendered on the page: :ref:`navigation-toolbar`.
312+
as rendered on the page: :ref:`thirdparty-index`.
313313

314314
Files can be included verbatim. For instance the ``matplotlibrc`` file
315315
is important for customizing Matplotlib, and is included verbatim in the

‎doc/missing-references.json

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
{
2+
"c:var": {
3+
"PyOS_InputHook": [
4+
"doc/users/interactive_guide.rst:401",
5+
"doc/users/interactive_guide.rst:411"
6+
]
7+
},
28
"py:attr": {
39
"ax": [
410
"lib/mpl_toolkits/axes_grid1/colorbar.py:docstring of mpl_toolkits.axes_grid1.colorbar.ColorbarBase:23"
@@ -453,6 +459,9 @@
453459
"FigureCanvasQTAgg.print_figure": [
454460
"doc/api/prev_api_changes/api_changes_2.2.0.rst:199"
455461
],
462+
"IPython.terminal.interactiveshell.TerminalInteractiveShell.inputhook": [
463+
"doc/users/interactive_guide.rst:428"
464+
],
456465
"_find_tails": [
457466
"lib/matplotlib/quiver.py:docstring of matplotlib.quiver.Barbs:9"
458467
],
@@ -521,6 +530,9 @@
521530
]
522531
},
523532
"py:mod": {
533+
"IPython.terminal.pt_inputhooks": [
534+
"doc/users/interactive_guide.rst:428"
535+
],
524536
"dateutil": [
525537
"lib/matplotlib/dates.py:docstring of matplotlib.dates:1"
526538
],
@@ -562,6 +574,9 @@
562574
"./gallery/index.html": [
563575
"doc/devel/contributing.rst:562"
564576
],
577+
"Artist.stale_callback": [
578+
"doc/users/interactive_guide.rst:326"
579+
],
565580
"Artist.sticky_edges": [
566581
"doc/api/axes_api.rst:362:<autosummary>:1",
567582
"lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes.use_sticky_edges:2"
@@ -640,6 +655,9 @@
640655
"doc/gallery/misc/ftface_props.rst:16",
641656
"lib/matplotlib/font_manager.py:docstring of matplotlib.font_manager.ttfFontProperty:8"
642657
],
658+
"Figure.stale_callback": [
659+
"doc/users/interactive_guide.rst:336"
660+
],
643661
"FigureCanvas": [
644662
"lib/matplotlib/backend_tools.py:docstring of matplotlib.backend_tools.ToolBase:25"
645663
],
@@ -966,6 +984,9 @@
966984
"invert_yaxis": [
967985
"lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.get_ylim3d:24"
968986
],
987+
"ipykernel.pylab.backend_inline": [
988+
"doc/users/interactive.rst:249"
989+
],
969990
"kde.covariance_factor": [
970991
"lib/matplotlib/mlab.py:docstring of matplotlib.mlab.GaussianKDE:41"
971992
],

0 commit comments

Comments
 (0)
0