Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Reorganise mpl_toolkits documentation #5752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 32 commits into from
Jan 8, 2016
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
999786f
Move axesgrid1 api docs to axesgrid1
jenshnielsen Dec 26, 2015
8f461a2
Move non bundled packages from toolkits to resources
jenshnielsen Dec 26, 2015
b72e97a
Split documentation in axisartist and axes_grid1
jenshnielsen Dec 26, 2015
786c389
Move axisartist userguide to axisartist
jenshnielsen Dec 26, 2015
e9a9cc8
Remove warning
jenshnielsen Dec 26, 2015
a8ae5aa
Split axes_grid1 and axisartist examples
jenshnielsen Dec 26, 2015
60a8b7f
Correct links to examples
jenshnielsen Dec 26, 2015
535eb24
Correct links in whatsnew
jenshnielsen Dec 26, 2015
d49bbce
Correct links to gallery
jenshnielsen Dec 26, 2015
047ccb2
Split figures in axisartist and axisgrid1
jenshnielsen Dec 26, 2015
b1798b6
Correct links to figures
jenshnielsen Dec 26, 2015
138a6c1
Move axisartist docs
jenshnielsen Dec 26, 2015
ef84b93
Move overview docs up one level
jenshnielsen Dec 26, 2015
b41caa4
Clarify index
jenshnielsen Dec 28, 2015
44fb5ea
Update axes_grid1 overview
jenshnielsen Dec 29, 2015
9862d43
Update axes_grid1 some more
jenshnielsen Dec 29, 2015
a2d8009
update axisartist
jenshnielsen Dec 29, 2015
69705a7
Copy all remaing functionality from axes_grid to axisartist
jenshnielsen Dec 29, 2015
b17e5d6
Deprecate mpl_toolkits.axes_grid
jenshnielsen Dec 29, 2015
74da787
Move third party packages to its own toplevel index
jenshnielsen Dec 29, 2015
f6a4c78
Correct module name for axisartist
jenshnielsen Dec 29, 2015
3446e2c
Correct links on front page
jenshnielsen Dec 29, 2015
dd8a782
Update examples readme
jenshnielsen Dec 29, 2015
0635dfe
Remove the use of axes_grid from plotting userguide
jenshnielsen Dec 29, 2015
3b52513
remove pre python26 workaround
jenshnielsen Dec 29, 2015
5846f77
axes_grid to axes_grid1 in whatsnew
jenshnielsen Dec 29, 2015
6e805cf
Don't mention axes_grid in the annotation guide
jenshnielsen Dec 29, 2015
969982e
Remove toc trees
jenshnielsen Dec 30, 2015
00cdd55
Add note about the Matplotlib github org
jenshnielsen Dec 30, 2015
e47e071
Correct typos found by mdboom
jenshnielsen Dec 30, 2015
e817d39
Add api changes about deprecating axes_grid
jenshnielsen Dec 30, 2015
301980c
Correct typos found by @WeatherGod
jenshnielsen Jan 5, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update axes_grid1 overview
Remove all use of axisartist from overview of axes_grid1
  • Loading branch information
jenshnielsen committed Jan 5, 2016
commit 44fb5ea5de9fea9b88ea0d64c55ea549bc6bca8c
4 changes: 2 additions & 2 deletions doc/mpl_toolkits/axes_grid1/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Matplotlib AxesGrid1 Toolkit
The matplotlib :class:`mpl_toolkits.axes_grid1` toolkit is a collection of
helper classes to ease displaying multiple images in matplotlib. While the
aspect parameter in matplotlib adjust the position of the single axes,
AxesGrid1 toolkit provides a framework to adjust the position of
axesgrid1 toolkit provides a framework to adjust the position of
multiple axes according to their aspects.


Expand All @@ -16,7 +16,7 @@ multiple axes according to their aspects.
.. note::
AxesGrid toolkit has been a part of matplotlib since v
0.99. Originally, the toolkit had a single namespace of
*axes_grid*. In more recent version (since svn r8226), the toolkit
*axes_grid*. In more recent version, the toolkit
has divided into two separate namespace (*axes_grid1* and *axisartist*).
While *axes_grid* namespace is maintained for the backward compatibility,
use of *axes_grid1* and *axisartist* is recommended.
Expand Down
18 changes: 9 additions & 9 deletions doc/mpl_toolkits/axes_grid1/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
Overview of AxesGrid1 toolkit
=============================

What is AxesGrid1 toolkit?
==========================
What is axes_grid1 toolkit?
===========================

The matplotlib AxesGrid1 toolkit is a collection of helper classes,
The matplotlib axes_grid1 toolkit is a collection of helper classes,
mainly to ease displaying (multiple) images in matplotlib.

.. contents::
Expand Down Expand Up @@ -38,7 +38,7 @@ like the legend.
.. plot:: mpl_toolkits/axes_grid1/examples/demo_axes_grid.py


Axes_grid1
axes_grid1
==========

ImageGrid
Expand Down Expand Up @@ -85,7 +85,7 @@ axes).



AxesGrid takes following arguments,
ImageGrid takes following arguments,


============= ======== ================================================
Expand Down Expand Up @@ -152,7 +152,7 @@ attribute.



The examples below show what you can do with AxesGrid.
The examples below show what you can do with ImageGrid.

.. plot:: mpl_toolkits/axes_grid1/examples/demo_axes_grid.py

Expand Down Expand Up @@ -267,7 +267,7 @@ tick-formatter for bottom(or left)-axis. ::
r"$\pi$", r"$\frac{3}{2}\pi$", r"$2\pi$"])


.. plot:: mpl_toolkits/axisartist/examples/simple_axisline4.py
.. plot:: mpl_toolkits/axis_grid1/examples/simple_axisline4.py



Expand Down Expand Up @@ -296,11 +296,11 @@ coordinate.
InsetLocator
------------

:mod:`mpl_toolkits.axes_grid.inset_locator` provides helper classes
:mod:`mpl_toolkits.axes_grid1.inset_locator` provides helper classes
and functions to place your (inset) axes at the anchored position of
the parent axes, similarly to AnchoredArtist.

Using :func:`mpl_toolkits.axes_grid.inset_locator.inset_axes`, you
Using :func:`mpl_toolkits.axes_grid1.inset_locator.inset_axes`, you
can have inset axes whose size is either fixed, or a fixed proportion
of the parent axes. For example,::

Expand Down
69 changes: 34 additions & 35 deletions examples/axes_grid1/demo_axes_grid.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import matplotlib.pyplot as plt
from mpl_toolkits.axes_grid1 import AxesGrid
from mpl_toolkits.axes_grid1 import ImageGrid


def get_demo_image():
Expand All @@ -16,11 +16,11 @@ def demo_simple_grid(fig):
A grid of 2x2 images with 0.05 inch pad between images and only
the lower-left axes is labeled.
"""
grid = AxesGrid(fig, 141, # similar to subplot(141)
nrows_ncols=(2, 2),
axes_pad=0.05,
label_mode="1",
)
grid = ImageGrid(fig, 141, # similar to subplot(141)
nrows_ncols=(2, 2),
axes_pad=0.05,
label_mode="1",
)

Z, extent = get_demo_image()
for i in range(4):
Expand All @@ -36,19 +36,18 @@ def demo_grid_with_single_cbar(fig):
"""
A grid of 2x2 images with a single colorbar
"""
grid = AxesGrid(fig, 142, # similar to subplot(142)
nrows_ncols=(2, 2),
axes_pad=0.0,
share_all=True,
label_mode="L",
cbar_location="top",
cbar_mode="single",
)
grid = ImageGrid(fig, 142, # similar to subplot(142)
nrows_ncols=(2, 2),
axes_pad=0.0,
share_all=True,
label_mode="L",
cbar_location="top",
cbar_mode="single",
)

Z, extent = get_demo_image()
for i in range(4):
im = grid[i].imshow(Z, extent=extent, interpolation="nearest")
#plt.colorbar(im, cax = grid.cbar_axes[0])
grid.cbar_axes[0].colorbar(im)

for cax in grid.cbar_axes:
Expand All @@ -64,16 +63,16 @@ def demo_grid_with_each_cbar(fig):
A grid of 2x2 images. Each image has its own colorbar.
"""

grid = AxesGrid(fig, 143, # similar to subplot(143)
nrows_ncols=(2, 2),
axes_pad=0.1,
label_mode="1",
share_all=True,
cbar_location="top",
cbar_mode="each",
cbar_size="7%",
cbar_pad="2%",
)
grid = ImageGrid(fig, 143, # similar to subplot(143)
nrows_ncols=(2, 2),
axes_pad=0.1,
label_mode="1",
share_all=True,
cbar_location="top",
cbar_mode="each",
cbar_size="7%",
cbar_pad="2%",
)
Z, extent = get_demo_image()
for i in range(4):
im = grid[i].imshow(Z, extent=extent, interpolation="nearest")
Expand All @@ -92,16 +91,16 @@ def demo_grid_with_each_cbar_labelled(fig):
A grid of 2x2 images. Each image has its own colorbar.
"""

grid = AxesGrid(fig, 144, # similar to subplot(144)
nrows_ncols=(2, 2),
axes_pad=(0.45, 0.15),
label_mode="1",
share_all=True,
cbar_location="right",
cbar_mode="each",
cbar_size="7%",
cbar_pad="2%",
)
grid = ImageGrid(fig, 144, # similar to subplot(144)
nrows_ncols=(2, 2),
axes_pad=(0.45, 0.15),
label_mode="1",
share_all=True,
cbar_location="right",
cbar_mode="each",
cbar_size="7%",
cbar_pad="2%",
)
Z, extent = get_demo_image()

# Use a different colorbar range every time
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
import mpl_toolkits.axisartist as AA
import numpy as np

ax = host_subplot(111, axes_class=AA.Axes)
ax = host_subplot(111)
xx = np.arange(0, 2*np.pi, 0.01)
ax.plot(xx, np.sin(xx))

Expand Down