Reorganise mpl_toolkits documentation #5752
Merged
Commits
Show all changes
32 commits
Select commit
Hold shift + click to select a range
999786f
Move axesgrid1 api docs to axesgrid1
jenshnielsen 8f461a2
Move non bundled packages from toolkits to resources
jenshnielsen b72e97a
Split documentation in axisartist and axes_grid1
jenshnielsen 786c389
Move axisartist userguide to axisartist
jenshnielsen e9a9cc8
Remove warning
jenshnielsen a8ae5aa
Split axes_grid1 and axisartist examples
jenshnielsen 60a8b7f
Correct links to examples
jenshnielsen 535eb24
Correct links in whatsnew
jenshnielsen d49bbce
Correct links to gallery
jenshnielsen 047ccb2
Split figures in axisartist and axisgrid1
jenshnielsen b1798b6
Correct links to figures
jenshnielsen 138a6c1
Move axisartist docs
jenshnielsen ef84b93
Move overview docs up one level
jenshnielsen b41caa4
Clarify index
jenshnielsen 44fb5ea
Update axes_grid1 overview
jenshnielsen 9862d43
Update axes_grid1 some more
jenshnielsen a2d8009
update axisartist
jenshnielsen 69705a7
Copy all remaing functionality from axes_grid to axisartist
jenshnielsen b17e5d6
Deprecate mpl_toolkits.axes_grid
jenshnielsen 74da787
Move third party packages to its own toplevel index
jenshnielsen f6a4c78
Correct module name for axisartist
jenshnielsen 3446e2c
Correct links on front page
jenshnielsen dd8a782
Update examples readme
jenshnielsen 0635dfe
Remove the use of axes_grid from plotting userguide
jenshnielsen 3b52513
remove pre python26 workaround
jenshnielsen 5846f77
axes_grid to axes_grid1 in whatsnew
jenshnielsen 6e805cf
Don't mention axes_grid in the annotation guide
jenshnielsen 969982e
Remove toc trees
jenshnielsen 00cdd55
Add note about the Matplotlib github org
jenshnielsen e47e071
Correct typos found by mdboom
jenshnielsen e817d39
Add api changes about deprecating axes_grid
jenshnielsen 301980c
Correct typos found by @WeatherGod
jenshnielsen
Jump to file
No files or symbols found.
+13
−5
index.html
doc/_templates/index.html
+7
−0
2015-12-30-JHN.rst
doc/api/api_changes/2015-12-30-JHN.rst
+2
−1
conf.py
doc/conf.py
+1
−0
contents.rst
doc/contents.rst
+2
−1
make.py
doc/make.py
+0
−18
axes_divider_api.rst
doc/mpl_toolkits/axes_grid/api/axes_divider_api.rst
+0
−11
axes_grid_api.rst
doc/mpl_toolkits/axes_grid/api/axes_grid_api.rst
+0
−6
axes_size_api.rst
doc/mpl_toolkits/axes_grid/api/axes_size_api.rst
+0
−16
axis_artist_api.rst
doc/mpl_toolkits/axes_grid/api/axis_artist_api.rst
+0
−1
examples
doc/mpl_toolkits/axes_grid/examples
+0
−36
index.rst
doc/mpl_toolkits/axes_grid/index.rst
0
anchored_artists_api.rst/{ → }
...axes_grid → axes_grid1}/api/anchored_artists_api.rst
+18
−0
axes_divider_api.rst
doc/mpl_toolkits/axes_grid1/api/axes_divider_api.rst
+11
−0
axes_grid_api.rst
doc/mpl_toolkits/axes_grid1/api/axes_grid_api.rst
+5
−0
axes_size_api.rst
doc/mpl_toolkits/axes_grid1/api/axes_size_api.rst
+3
−15
index.rst/{ → }
doc/mpl_toolkits/{axes_grid → axes_grid1}/api/index.rst
0
inset_locator_api.rst/{ → }
...s/{axes_grid → axes_grid1}/api/inset_locator_api.rst
+1
−0
examples
doc/mpl_toolkits/axes_grid1/examples
+2
−3
demo_colorbar_of_inset_axes.py/{ → }
...→ axes_grid1}/figures/demo_colorbar_of_inset_axes.py
+2
−3
demo_colorbar_with_axes_divider.py/{ → }
...es_grid1}/figures/demo_colorbar_with_axes_divider.py
+1
−2
demo_fixed_size_axes.py/{ → }
...s_grid → axes_grid1}/figures/demo_fixed_size_axes.py
+1
−2
demo_new_colorbar.py/{ → }
...axes_grid → axes_grid1}/figures/demo_new_colorbar.py
0
parasite_simple.py/{ → }
.../{axes_grid → axes_grid1}/figures/parasite_simple.py
+2
−3
simple_axes_divider1.py/{ → }
...s_grid → axes_grid1}/figures/simple_axes_divider1.py
+2
−2
simple_axes_divider2.py/{ → }
...s_grid → axes_grid1}/figures/simple_axes_divider2.py
+2
−2
simple_axes_divider3.py/{ → }
...s_grid → axes_grid1}/figures/simple_axes_divider3.py
0
simple_colorbar.py/{ → }
.../{axes_grid → axes_grid1}/figures/simple_colorbar.py
0
simple_rgb.py/{ → }
...lkits/{axes_grid → axes_grid1}/figures/simple_rgb.py
+29
−0
index.rst
doc/mpl_toolkits/axes_grid1/index.rst
+25
−149
overview.rst/{ → }
...toolkits/{axes_grid/users → axes_grid1}/overview.rst
+7
−8
axes_divider.rst/{ → }
...kits/{axes_grid → axes_grid1}/users/axes_divider.rst
+12
−0
index.rst
doc/mpl_toolkits/axes_grid1/users/index.rst
+16
−0
axis_artist_api.rst
doc/mpl_toolkits/axisartist/api/axis_artist_api.rst
+12
−0
index.rst
doc/mpl_toolkits/axisartist/api/index.rst
+1
−0
examples
doc/mpl_toolkits/axisartist/examples
0
axis_direction_demo_step01.py/{ → }
... → axisartist}/figures/axis_direction_demo_step01.py
0
axis_direction_demo_step02.py/{ → }
... → axisartist}/figures/axis_direction_demo_step02.py
0
axis_direction_demo_step03.py/{ → }
... → axisartist}/figures/axis_direction_demo_step03.py
0
axis_direction_demo_step04.py/{ → }
... → axisartist}/figures/axis_direction_demo_step04.py
0
demo_axis_direction.py/{ → }
...es_grid → axisartist}/figures/demo_axis_direction.py
+1
−1
demo_parasite_axes.py/{ → }
...xes_grid → axisartist}/figures/demo_parasite_axes.py
0
demo_ticklabel_alignment.py/{ → }
...id → axisartist}/figures/demo_ticklabel_alignment.py
+1
−1
demo_ticklabel_direction.py/{ → }
...id → axisartist}/figures/demo_ticklabel_direction.py
0
simple_axis_direction01.py/{ → }
...rid → axisartist}/figures/simple_axis_direction01.py
0
simple_axis_direction03.py/{ → }
...rid → axisartist}/figures/simple_axis_direction03.py
0
simple_axis_pad.py/{ → }
.../{axes_grid → axisartist}/figures/simple_axis_pad.py
0
simple_axisartist1.py/{ → }
...xes_grid → axisartist}/figures/simple_axisartist1.py
+1
−2
simple_axisline.py/{ → }
.../{axes_grid → axisartist}/figures/simple_axisline.py
+1
−2
simple_axisline2.py/{ → }
...{axes_grid → axisartist}/figures/simple_axisline2.py
+1
−2
simple_axisline3.py/{ → }
...{axes_grid → axisartist}/figures/simple_axisline3.py
+11
−0
index.rst
doc/mpl_toolkits/axisartist/index.rst
+117
−0
overview.rst
doc/mpl_toolkits/axisartist/overview.rst
+24
−24
axisartist.rst/{ → }
...olkits/{axes_grid → axisartist}/users/axisartist.rst
+2
−4
index.rst/{ → }
...pl_toolkits/{axes_grid → axisartist}/users/index.rst
+15
−144
index.rst
doc/mpl_toolkits/index.rst
+1
−1
whats_new_99_axes_grid.py
doc/pyplots/whats_new_99_axes_grid.py
+130
−0
index.rst
doc/thirdpartypackages/index.rst
+6
−5
annotations_guide.rst
doc/users/annotations_guide.rst
+1
−1
anchored_box01.py
doc/users/plotting/examples/anchored_box01.py
+1
−1
anchored_box02.py
doc/users/plotting/examples/anchored_box02.py
+1
−1
anchored_box03.py
doc/users/plotting/examples/anchored_box03.py
+2
−2
annotate_explain.py
doc/users/plotting/examples/annotate_explain.py
+2
−2
connectionstyle_demo.py
doc/users/plotting/examples/connectionstyle_demo.py
+1
−14
demo_gridspec06.py
doc/users/plotting/examples/demo_gridspec06.py
+3
−2
simple_annotate01.py
doc/users/plotting/examples/simple_annotate01.py
+3
−2
whats_new.rst
doc/users/whats_new.rst
+3
−1
README.txt
examples/README.txt
0
demo_axes_divider.py/{ → }
examples/{axes_grid → axes_grid1}/demo_axes_divider.py
+34
−35
demo_axes_grid.py/{ → }
examples/{axes_grid → axes_grid1}/demo_axes_grid.py
0
demo_axes_grid2.py/{ → }
examples/{axes_grid → axes_grid1}/demo_axes_grid2.py
0
demo_axes_hbox_divider.py/{ → }
...s/{axes_grid → axes_grid1}/demo_axes_hbox_divider.py
0
demo_axes_rgb.py/{ → }
examples/{axes_grid → axes_grid1}/demo_axes_rgb.py
0
demo_colorbar_with_inset_locator.py/{ → }
...id → axes_grid1}/demo_colorbar_with_inset_locator.py
0
demo_edge_colorbar.py/{ → }
examples/{axes_grid → axes_grid1}/demo_edge_colorbar.py
0
demo_imagegrid_aspect.py/{ → }
...es/{axes_grid → axes_grid1}/demo_imagegrid_aspect.py
0
inset_locator_demo.py/{ → }
examples/{axes_grid → axes_grid1}/inset_locator_demo.py
0
inset_locator_demo2.py/{ → }
...ples/{axes_grid → axes_grid1}/inset_locator_demo2.py
0
make_room_for_ylabel_using_axesgrid.py/{ → }
...→ axes_grid1}/make_room_for_ylabel_using_axesgrid.py
0
parasite_simple2.py/{ → }
examples/{axes_grid → axes_grid1}/parasite_simple2.py
0
scatter_hist.py/{ → }
examples/{axes_grid → axes_grid1}/scatter_hist.py
0
simple_anchored_artists.py/{ → }
.../{axes_grid → axes_grid1}/simple_anchored_artists.py
0
simple_axesgrid.py/{ → }
examples/{axes_grid → axes_grid1}/simple_axesgrid.py
0
simple_axesgrid2.py/{ → }
examples/{axes_grid → axes_grid1}/simple_axesgrid2.py
+1
−1
simple_axisline4.py/{ → }
examples/{axes_grid → axes_grid1}/simple_axisline4.py
+1
−1
demo_axisline_style.py/{ → }
...ples/{axes_grid → axisartist}/demo_axisline_style.py
0
demo_curvelinear_grid.py/{ → }
...es/{axes_grid → axisartist}/demo_curvelinear_grid.py
+3
−3
demo_curvelinear_grid2.py/{ → }
...s/{axes_grid → axisartist}/demo_curvelinear_grid2.py
0
demo_floating_axes.py/{ → }
examples/{axes_grid → axisartist}/demo_floating_axes.py
0
demo_floating_axis.py/{ → }
examples/{axes_grid → axisartist}/demo_floating_axis.py
0
demo_parasite_axes2.py/{ → }
...ples/{axes_grid → axisartist}/demo_parasite_axes2.py
+7
−0
__init__.py
lib/mpl_toolkits/axes_grid/__init__.py
+10
−0
axes_divider.py
lib/mpl_toolkits/axisartist/axes_divider.py
+32
−0
axes_grid.py
lib/mpl_toolkits/axisartist/axes_grid.py
+13
−0
axes_rgb.py
lib/mpl_toolkits/axisartist/axes_rgb.py
+20
−0
parasite_axes.py
lib/mpl_toolkits/axisartist/parasite_axes.py
| @@ -0,0 +1,7 @@ | ||
| +`mpl_toolkits.axes_grid` has been deprecated | ||
| +```````````````````````````````````````````` | ||
| + | ||
| +All functionallity from `mpl_toolkits.axes_grid` can be found in either | ||
| +`mpl_toolkits.axes_grid1` or `mpl_toolkits.axisartist`. Axes classes from | ||
| +`mpl_toolkits.axes_grid` based on `Axis` from `mpl_toolkits.axisartist` can be | ||
| +found in `mpl_toolkits.axisartist` |
| @@ -1,18 +0,0 @@ | ||
| - | ||
| -:mod:`mpl_toolkits.axes_grid.axes_divider` | ||
| -========================================== | ||
| - | ||
| -.. autoclass:: mpl_toolkits.axes_grid.axes_divider.Divider | ||
| - :members: | ||
| - :undoc-members: | ||
| - | ||
| - | ||
| -.. autoclass:: mpl_toolkits.axes_grid.axes_divider.AxesLocator | ||
| - :members: | ||
| - :undoc-members: | ||
| - | ||
| -.. autoclass:: mpl_toolkits.axes_grid.axes_divider.SubplotDivider | ||
| - :members: | ||
| - | ||
| -.. autoclass:: mpl_toolkits.axes_grid.axes_divider.AxesDivider | ||
| - :members: |
| @@ -1,11 +0,0 @@ | ||
| - | ||
| -:mod:`mpl_toolkits.axes_grid.axes_grid` | ||
| -======================================= | ||
| - | ||
| -.. autoclass:: mpl_toolkits.axes_grid.axes_grid.Grid | ||
| - :members: | ||
| - :undoc-members: | ||
| - | ||
| -.. autoclass:: mpl_toolkits.axes_grid.axes_grid.ImageGrid | ||
| - :members: | ||
| - :undoc-members: |
| @@ -1,6 +0,0 @@ | ||
| -:mod:`mpl_toolkits.axes_grid.axes_size` | ||
| -======================================= | ||
| - | ||
| -.. automodule:: mpl_toolkits.axes_grid.axes_size | ||
| - :members: Fixed, Scaled, AxesX, AxesY, MaxWidth, MaxHeight, Fraction, Padded, from_any | ||
| - |
| @@ -1,16 +0,0 @@ | ||
| - | ||
| -:mod:`mpl_toolkits.axes_grid.axis_artist` | ||
| -========================================= | ||
| - | ||
| -.. autoclass:: mpl_toolkits.axes_grid.axis_artist.AxisArtist | ||
| - :members: | ||
| - :undoc-members: | ||
| - | ||
| -.. autoclass:: mpl_toolkits.axes_grid.axis_artist.Ticks | ||
| - :members: | ||
| - | ||
| -.. autoclass:: mpl_toolkits.axes_grid.axis_artist.AxisLabel | ||
| - :members: | ||
| - | ||
| -.. autoclass:: mpl_toolkits.axes_grid.axis_artist.TickLabels | ||
| - :members: |
| @@ -1 +0,0 @@ | ||
| -../../../examples/axes_grid/ |
| @@ -1,36 +0,0 @@ | ||
| - | ||
| -.. _toolkit_axesgrid-index: | ||
| - | ||
| -Matplotlib AxesGrid Toolkit | ||
| -=========================== | ||
| - | ||
| -The matplotlib AxesGrid 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, | ||
| -AxesGrid toolkit provides a framework to adjust the position of | ||
| -multiple axes according to their aspects. | ||
| - | ||
| - | ||
| -.. image:: ../../_static/demo_axes_grid.png | ||
| - | ||
| -.. 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 | ||
| - 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. | ||
| - | ||
| -.. warning:: | ||
| - *axes_grid* and *axisartist* (but not *axes_grid1*) uses | ||
| - a custom Axes class (derived from the mpl's original Axes class). | ||
| - As a side effect, some commands (mostly tick-related) do not work. | ||
| - Use *axes_grid1* to avoid this, or see how things are different in | ||
| - *axes_grid* and *axisartist* (LINK needed) | ||
| - | ||
| -.. toctree:: | ||
| - :maxdepth: 2 | ||
| - | ||
| - users/overview.rst | ||
| - users/index.rst | ||
| - api/index.rst |
File renamed without changes.
| @@ -0,0 +1,18 @@ | ||
| + | ||
| +:mod:`mpl_toolkits.axes_grid1.axes_divider` | ||
| +=========================================== | ||
| + | ||
| +.. autoclass:: mpl_toolkits.axes_grid1.axes_divider.Divider | ||
| + :members: | ||
| + :undoc-members: | ||
| + | ||
| + | ||
| +.. autoclass:: mpl_toolkits.axes_grid1.axes_divider.AxesLocator | ||
| + :members: | ||
| + :undoc-members: | ||
| + | ||
| +.. autoclass:: mpl_toolkits.axes_grid1.axes_divider.SubplotDivider | ||
| + :members: | ||
| + | ||
| +.. autoclass:: mpl_toolkits.axes_grid1.axes_divider.AxesDivider | ||
| + :members: |
| @@ -0,0 +1,11 @@ | ||
| + | ||
| +:mod:`mpl_toolkits.axes_grid1.axes_grid` | ||
| +======================================== | ||
| + | ||
| +.. autoclass:: mpl_toolkits.axes_grid1.axes_grid.Grid | ||
| + :members: | ||
| + :undoc-members: | ||
| + | ||
| +.. autoclass:: mpl_toolkits.axes_grid1.axes_grid.ImageGrid | ||
| + :members: | ||
| + :undoc-members: |
| @@ -0,0 +1,5 @@ | ||
| +:mod:`mpl_toolkits.axes_grid1.axes_size` | ||
| +======================================== | ||
| + | ||
| +.. automodule:: mpl_toolkits.axes_grid1.axes_size | ||
| + :members: Fixed, Scaled, AxesX, AxesY, MaxWidth, MaxHeight, Fraction, Padded, from_any |
| @@ -1,28 +1,16 @@ | ||
| -.. _axes_grid-api-index: | ||
| +.. _axes_grid1-api-index: | ||
| ####################################### | ||
| - The Matplotlib AxesGrid Toolkit API | ||
| + The Matplotlib axes_grid1 Toolkit API | ||
| ####################################### | ||
| :Release: |version| | ||
| :Date: |today| | ||
| .. toctree:: | ||
| + anchored_artists_api.rst | ||
| axes_size_api.rst | ||
| axes_divider_api.rst | ||
| axes_grid_api.rst | ||
| - axis_artist_api.rst | ||
| - | ||
| - | ||
| -####################################### | ||
| - The Matplotlib axes_grid1 Toolkit API | ||
| -####################################### | ||
| - | ||
| -:Release: |version| | ||
| -:Date: |today| | ||
| - | ||
| -.. toctree:: | ||
| - | ||
| - anchored_artists_api.rst | ||
| inset_locator_api.rst |
File renamed without changes.
| @@ -0,0 +1 @@ | ||
| +../../../examples/axes_grid1/ |
File renamed without changes.
File renamed without changes.
File renamed without changes.
| @@ -0,0 +1,29 @@ | ||
| + | ||
| +.. _toolkit_axesgrid1-index: | ||
| + | ||
| +Matplotlib axes_grid1 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 | ||
| +multiple axes according to their aspects. | ||
| + | ||
| + | ||
| +.. image:: ../../_static/demo_axes_grid.png | ||
| + | ||
| +.. 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, 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. | ||
| + | ||
| +.. toctree:: | ||
| + :maxdepth: 2 | ||
| + | ||
| + overview.rst | ||
| + users/index.rst | ||
| + api/index.rst |
Oops, something went wrong.