Merge pull request #4874 from sargas/cleanup-anchored-artists

jenshnielsen · QuLogic · commit ef06f5fbc2c2 · 2016-10-16T03:05:56.000-04:00
Document mpl_toolkits.axes_grid1.anchored_artists

Conflicts:
	lib/mpl_toolkits/axes_grid1/anchored_artists.py

Note that the removed imports were restored for this backport so as to
not break the API for 2.0. Whether they really should be moved or not is
a matter for a different PR.
diff --git a/doc/mpl_toolkits/axes_grid/api/anchored_artists_api.rst b/doc/mpl_toolkits/axes_grid/api/anchored_artists_api.rst
@@ -0,0 +1,7 @@
+:mod:`mpl_toolkits.axes_grid1.anchored_artists`
+===============================================
+
+.. automodule:: mpl_toolkits.axes_grid1.anchored_artists
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/mpl_toolkits/axes_grid/api/index.rst b/doc/mpl_toolkits/axes_grid/api/index.rst
@@ -24,4 +24,5 @@
 
 .. toctree::
 
+    anchored_artists_api.rst
     inset_locator_api.rst
diff --git a/examples/axes_grid/simple_anchored_artists.py b/examples/axes_grid/simple_anchored_artists.py
@@ -2,7 +2,7 @@
 
 
 def draw_text(ax):
-    from mpl_toolkits.axes_grid1.anchored_artists import AnchoredText
+    from matplotlib.offsetbox import AnchoredText
     at = AnchoredText("Figure 1a",
                       loc=2, prop=dict(size=8), frameon=True,
                       )
diff --git a/lib/mpl_toolkits/axes_grid1/anchored_artists.py b/lib/mpl_toolkits/axes_grid1/anchored_artists.py

Original file line number	Diff line number	Diff line change
`@@ -24,4 +24,5 @@`
`24`	`24`
`25`	`25`	`.. toctree::`
`26`	`26`
	`27`	`+ anchored_artists_api.rst`
`27`	`28`	`inset_locator_api.rst`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`
`4`	`4`	`def draw_text(ax):`
`5`		`- from mpl_toolkits.axes_grid1.anchored_artists import AnchoredText`
	`5`	`+ from matplotlib.offsetbox import AnchoredText`
`6`	`6`	`at = AnchoredText("Figure 1a",`
`7`	`7`	`loc=2, prop=dict(size=8), frameon=True,`
`8`	`8`	`)`