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

Skip to content

Commit 5eec831

Browse files
committed
Merge pull request #5752 from jenshnielsen/axisgriddocs
Reorganise mpl_toolkits documentation
2 parents 73f90a2 + 301980c commit 5eec831

95 files changed

Lines changed: 626 additions & 536 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

doc/_templates/index.html

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -160,13 +160,21 @@ <h4>Need help?</h4>
160160

161161
<h1>Toolkits</h1>
162162

163-
<p>There are several matplotlib add-on <a href="{{ pathto('mpl_toolkits/index') }}">toolkits</a>,
164-
including a choice of two projection and mapping toolkits <a href="http://matplotlib.org/basemap">basemap</a> and
165-
<a href="http://scitools.org.uk/cartopy/docs/latest">cartopy</a>,
166-
3d plotting with <a href="{{ pathto('mpl_toolkits/mplot3d/index') }}">mplot3d</a>,
167-
axes and axis helpers in <a href="{{ pathto('mpl_toolkits/axes_grid/index') }}">axes_grid</a> and more.
163+
<p>Matplotlib ships with several add-on <a href="{{ pathto('mpl_toolkits/index') }}">toolkits</a>,
164+
Including 3d plotting with <a href="{{ pathto('mpl_toolkits/mplot3d/index') }}">mplot3d</a>,
165+
axes helpers in <a href="{{ pathto('mpl_toolkits/axes_grid1/index') }}">axes_grid1</a> and
166+
axis helpers in <a href="{{ pathto('mpl_toolkits/axisartist/index') }}">axisartist</a>.
168167
</p>
169168

169+
<h1>Third party packages</h1>
170+
171+
<p>A large number of third party <a href="{{ pathto('mpl_toolkits/index') }}">packages</a>
172+
extend and build on Matplotlib functionality,
173+
including a choice of two projection and mapping toolkits
174+
<a href="http://matplotlib.org/basemap">basemap</a> and
175+
<a href="http://scitools.org.uk/cartopy/docs/latest">cartopy</a>.
176+
</p>
177+
170178
<h1>Citing matplotlib</h1>
171179

172180
<p>
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
`mpl_toolkits.axes_grid` has been deprecated
2+
````````````````````````````````````````````
3+
4+
All functionallity from `mpl_toolkits.axes_grid` can be found in either
5+
`mpl_toolkits.axes_grid1` or `mpl_toolkits.axisartist`. Axes classes from
6+
`mpl_toolkits.axes_grid` based on `Axis` from `mpl_toolkits.axisartist` can be
7+
found in `mpl_toolkits.axisartist`

doc/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,8 @@
135135
('api', 'API'),
136136
('pylab_examples', 'pylab examples'),
137137
('mplot3d', 'mplot3d toolkit'),
138-
('axes_grid', 'axes_grid toolkit'),
138+
('axes_grid1', 'axes_grid1 toolkit'),
139+
('axisartist', 'axisartist toolkit'),
139140
('units', 'units'),
140141
('widgets', 'widgets'),
141142
)

doc/contents.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Overview
1818
users/index.rst
1919
faq/index.rst
2020
resources/index.rst
21+
thirdpartypackages/index.rst
2122
devel/index.rst
2223
mpl_toolkits/index.rst
2324
api/index.rst

doc/make.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,8 @@ def all():
149149

150150
required_symlinks = [
151151
('mpl_examples', '../examples/'),
152-
('mpl_toolkits/axes_grid/examples', '../../../examples/axes_grid/')
152+
('mpl_toolkits/axes_grid1/examples', '../../../examples/axes_grid1/'),
153+
('mpl_toolkits/axisartist/examples', '../../../examples/axisartist/')
153154
]
154155

155156
symlink_warnings = []

doc/mpl_toolkits/axes_grid/api/axes_divider_api.rst

Lines changed: 0 additions & 18 deletions
This file was deleted.

doc/mpl_toolkits/axes_grid/api/axes_grid_api.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

doc/mpl_toolkits/axes_grid/api/axes_size_api.rst

Lines changed: 0 additions & 6 deletions
This file was deleted.

doc/mpl_toolkits/axes_grid/api/axis_artist_api.rst

Lines changed: 0 additions & 16 deletions
This file was deleted.

doc/mpl_toolkits/axes_grid/examples

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)