From b89e71061a2a851362cb12cdab2483f05e5776f1 Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Mon, 12 Aug 2019 19:14:59 -0400 Subject: [PATCH 1/3] DOC: resolve a bunch of nitpick issues The Axes classes have a multi-layered internal class structure and we generate documentation for the top-level public classes. However, we also auto-generate property tables by querying the methods on the objects which resolve to the base class they are defined on which leads to incorrect references. This is a very quick hack which special-cases two of the Axes classes and replace their name with just ``Axes``. --- doc/missing-references.json | 362 +----------------------------------- lib/matplotlib/artist.py | 4 +- 2 files changed, 9 insertions(+), 357 deletions(-) diff --git a/doc/missing-references.json b/doc/missing-references.json index 1c4913123549..84bc5f40aacc 100644 --- a/doc/missing-references.json +++ b/doc/missing-references.json @@ -323,7 +323,7 @@ "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.xcorr:19" ], "AxesBase": [ - "doc/api/axes_api.rst:448::1", + "doc/api/axes_api.rst:451::1", "lib/matplotlib/axes/_base.py:docstring of matplotlib.axes.Axes.add_child_axes:2" ], "window_hanning": [ @@ -399,7 +399,7 @@ "lib/matplotlib/axes/_base.py:docstring of matplotlib.axes.Axes.get_window_extent:24" ], "Line2D": [ - "doc/api/axes_api.rst:417::1", + "doc/api/axes_api.rst:420::1", "doc/api/prev_api_changes/api_changes_1.5.0.rst:115", "doc/api/prev_api_changes/api_changes_2.1.0.rst:88", "doc/devel/MEP/MEP26.rst:141", @@ -777,8 +777,8 @@ "lib/mpl_toolkits/axes_grid1/axes_size.py:docstring of mpl_toolkits.axes_grid1.axes_size:1" ], "axes_class": [ - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:147", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:139" + "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:148", + "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:140" ], "pyplot.gcf()": [ "lib/mpl_toolkits/axes_grid1/parasite_axes.py:docstring of mpl_toolkits.axes_grid1.parasite_axes.host_axes:8", @@ -4106,356 +4106,6 @@ "subplot2grid": [ "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure:71" ], - "matplotlib.axes._base._AxesBase.set_adjustable": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:64", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:58", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:76", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:15", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:71", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:72", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:80", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:67", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:31" - ], - "matplotlib.axes._base._AxesBase.set_anchor": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:67", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:61", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:79", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:18", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:74", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:75", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:83", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:70", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:34" - ], - "matplotlib.axes._base._AxesBase.set_aspect": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:69", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:63", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:81", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:20", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:76", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:77", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:85", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:72", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:36" - ], - "matplotlib.axes._base._AxesBase.set_autoscale_on": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:70", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:64", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:82", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:21", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:77", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:78", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:86", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:73", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:37" - ], - "matplotlib.axes._base._AxesBase.set_autoscalex_on": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:71", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:65", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:83", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:22", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:78", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:79", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:87", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:74", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:38" - ], - "matplotlib.axes._base._AxesBase.set_autoscaley_on": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:72", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:66", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:84", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:23", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:79", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:80", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:88", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:75", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:39" - ], - "matplotlib.axes._base._AxesBase.set_axes_locator": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:73", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:67", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:85", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:24", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:80", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:81", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:89", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:76", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:40" - ], - "matplotlib.axes._base._AxesBase.set_axisbelow": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:74", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:68", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:86", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:25", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:81", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:82", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:90", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:77", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:41" - ], - "matplotlib.axes._base._AxesBase.set_facecolor": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:79", - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:80", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:73", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:74", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:91", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:92", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:30", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:31", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:86", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:87", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:87", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:88", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:95", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:96", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:82", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:83", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:46", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:47" - ], - "matplotlib.axes._base._AxesBase.set_figure": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:81", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:75", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:93", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:32", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:88", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:89", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:97", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:84", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:48" - ], - "matplotlib.axes._base._AxesBase.set_frame_on": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:82", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:76", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:94", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:33", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:89", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:90", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:98", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:85", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:49" - ], - "matplotlib.axes._base._AxesBase.set_navigate": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:86", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:80", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:98", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:37", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:93", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:94", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:102", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:89", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:53" - ], - "matplotlib.axes._base._AxesBase.set_navigate_mode": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:87", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:81", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:99", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:38", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:94", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:95", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:103", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:90", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:54" - ], - "matplotlib.axes._base._AxesBase.set_position": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:90", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:84", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:102", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:41", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:97", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:98", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:106", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:93", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:57" - ], - "matplotlib.axes._base._AxesBase.set_prop_cycle": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:91", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:85", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:103", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:42", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:98", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:99", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:107", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:94", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:58" - ], - "matplotlib.axes._base._AxesBase.set_rasterization_zorder": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:92", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:86", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:104", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:43", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:99", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:100", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:108", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:95", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:59" - ], - "matplotlib.axes._axes.Axes.set_title": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:96", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:90", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:108", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:47", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:103", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:104", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:112", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:99", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:63" - ], - "matplotlib.axes._base._AxesBase.set_xbound": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:100", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:94", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:112", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:51", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:107", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:108", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:116", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:103", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:67" - ], - "matplotlib.axes._axes.Axes.set_xlabel": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:101", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:95", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:113", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:52", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:108", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:109", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:117", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:104", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:68" - ], - "matplotlib.axes._base._AxesBase.set_xlim": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:102", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:96", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:114", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:53", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:109", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:110", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:118", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:105", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:69" - ], - "matplotlib.axes._base._AxesBase.set_xmargin": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:103", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:97", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:115", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:54", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:110", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:111", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:119", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:106", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:70" - ], - "matplotlib.axes._base._AxesBase.set_xscale": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:104", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:98", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:116", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:55", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:111", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:112", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:120", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:107", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:71" - ], - "matplotlib.axes._base._AxesBase.set_xticklabels": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:105", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:99", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:117", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:56", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:112", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:113", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:121", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:108", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:72" - ], - "matplotlib.axes._base._AxesBase.set_xticks": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:106", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:100", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:118", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:57", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:113", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:114", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:122", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:109", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:73" - ], - "matplotlib.axes._base._AxesBase.set_ybound": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:107", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:101", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:119", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:58", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:114", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:115", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:123", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:110", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:74" - ], - "matplotlib.axes._axes.Axes.set_ylabel": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:108", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:102", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:120", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:59", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:115", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:116", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:124", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:111", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:75" - ], - "matplotlib.axes._base._AxesBase.set_ylim": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:109", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:103", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:121", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:60", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:116", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:117", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:125", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:112", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:76" - ], - "matplotlib.axes._base._AxesBase.set_ymargin": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:110", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:104", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:122", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:61", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:117", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:118", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:126", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:113", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:77" - ], - "matplotlib.axes._base._AxesBase.set_yscale": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:111", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:105", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:123", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:62", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:118", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:119", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:127", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:114", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:78" - ], - "matplotlib.axes._base._AxesBase.set_yticklabels": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:112", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:106", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:124", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:63", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:119", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:120", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:128", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:115", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:79" - ], - "matplotlib.axes._base._AxesBase.set_yticks": [ - "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:113", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_axes:107", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.add_subplot:125", - "lib/matplotlib/figure.py:docstring of matplotlib.figure.Figure.gca:64", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axes:120", - "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.subplot:121", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.inset_axes:129", - "lib/mpl_toolkits/axes_grid1/inset_locator.py:docstring of mpl_toolkits.axes_grid1.inset_locator.zoomed_inset_axes:116", - "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:80" - ], "set_xlim": [ "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.axhspan:4", "lib/matplotlib/pyplot.py:docstring of matplotlib.pyplot.errorbar:60" @@ -4795,7 +4445,7 @@ ], "matplotlib.axes._axes.Axes": [ "doc/api/artist_api.rst:189", - "doc/api/axes_api.rst:685", + "doc/api/axes_api.rst:688", "lib/matplotlib/projections/polar.py:docstring of matplotlib.projections.polar.PolarAxes:1", "lib/mpl_toolkits/axes_grid1/mpl_axes.py:docstring of mpl_toolkits.axes_grid1.mpl_axes.Axes:1", "lib/mpl_toolkits/axisartist/axislines.py:docstring of mpl_toolkits.axisartist.axislines.Axes:1", @@ -4854,7 +4504,7 @@ ], "matplotlib.axes._base._AxesBase": [ "doc/api/artist_api.rst:189", - "doc/api/axes_api.rst:685", + "doc/api/axes_api.rst:688", "lib/matplotlib/axes/_axes.py:docstring of matplotlib.axes.Axes:1" ], "matplotlib.collections._CollectionWithSizes": [ diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py index 6ce0b5eed413..b86888918f52 100644 --- a/lib/matplotlib/artist.py +++ b/lib/matplotlib/artist.py @@ -1411,7 +1411,9 @@ def pprint_setters_rest(self, prop=None, leadingspace=4): attrs = sorted(self._get_setters_and_targets()) - names = [self.aliased_name_rest(prop, target) + names = [self.aliased_name_rest(prop, target).replace( + '_base._AxesBase', 'Axes').replace( + '_axes.Axes', 'Axes') for prop, target in attrs] accepts = [self.get_valid_values(prop) for prop, target in attrs] From f48ad733843d735096cb3a7d2ff02c6d05a96dbc Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Mon, 12 Aug 2019 19:22:45 -0400 Subject: [PATCH 2/3] DOC: fix single ` when double `` should have been used --- doc/devel/documenting_mpl.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst index c1b4d6728519..11bc9bb40586 100644 --- a/doc/devel/documenting_mpl.rst +++ b/doc/devel/documenting_mpl.rst @@ -425,8 +425,8 @@ As opposed to the numpydoc guide, parameters need not be marked as The optional aspect is already clear from the presence of a default value. More specifically -- use `{name} : {type}, default: {val}` when possible. -- use `{name} : {type}, optional` and describe the default in the text if +- use ``{name} : {type}, default: {val}`` when possible. +- use ``{name} : {type}, optional`` and describe the default in the text if in cannot be explained sufficiently in the above way. Use ``float`` for a type that can be any number. From 755740e4a9c36dec9939eed789bc31bbefe4a164 Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Mon, 12 Aug 2019 22:14:46 -0400 Subject: [PATCH 3/3] MNT: support building the docs on windows again --- doc/sphinxext/missing_references.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/sphinxext/missing_references.py b/doc/sphinxext/missing_references.py index 7c44afdbaac1..41e92653e97b 100644 --- a/doc/sphinxext/missing_references.py +++ b/doc/sphinxext/missing_references.py @@ -97,7 +97,10 @@ def get_location(node, app): (path, line) = get_source_line(node) if path: - + # sometimes the 'path' can contain ':' which are forbidden on + # windows, but on posix just passes through. + path, *post = path.partition(':') + post = ''.join(post) # We locate references relative to the parent of the doc # directory, which for matplotlib, will be the root of the # matplotlib repo. When matplotlib is not an editable install @@ -122,11 +125,11 @@ def get_location(node, app): else: path = "" - + post = '' if not line: line = "" - return f"{path}:{line}" + return f"{path}{post}:{line}" def _truncate_location(location): pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy