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.

Sign up for GitHub

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

Reorganise mpl_toolkits documentation #5752

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 axisartist
  • Loading branch information
@jenshnielsen
jenshnielsen committed Jan 5, 2016
commit a2d8009920f86d3f6aa9bb5262db1865c513edfb
2 changes: 1 addition & 1 deletion doc/mpl_toolkits/axisartist/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _toolkit_axisartist-index:

Matplotlib Axisartist Toolkit
Matplotlib axisartist Toolkit
=============================

.. toctree::
Expand Down
14 changes: 5 additions & 9 deletions doc/mpl_toolkits/axisartist/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
==============================
Overview of AxisArtist toolkit
Overview of axisartist toolkit
==============================

.. warning::
Expand All @@ -8,7 +8,7 @@ Overview of AxisArtist toolkit
As a side effect, some commands (mostly tick-related) do not work.


*axisartist* contains custom Axes class that is meant to support for
The *axisartist* contains custom Axes class that is meant to support for
curvilinear grids (e.g., the world coordinate system in astronomy).
Unlike mpl's original Axes class which uses Axes.xaxis and Axes.yaxis
to draw ticks, ticklines and etc., Axes in axisartist uses special
Expand All @@ -20,14 +20,10 @@ curved coordinate systems.
Since it uses a special artists, some mpl commands that work on
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uses a special -> uses special

Axes.xaxis and Axes.yaxis may not work.

AXISARTIST
==========


AxisArtist
axisartist
----------

AxisArtist module provides a custom (and very experimental) Axes
*axisartist* module provides a custom (and very experimental) Axes
class, where each axis (left, right, top and bottom) have a separate
artist associated which is responsible to draw axis-line, ticks,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

artist associated -> associated artist

ticklabels, label. Also, you can create your own axis, which can pass
Expand Down Expand Up @@ -81,7 +77,7 @@ Or a fixed axis with some offset ::



AxisArtist with ParasiteAxes
axisartist with ParasiteAxes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Most commands in the axes_grid1 toolkit can take a axes_class keyword
Expand Down
4 changes: 2 additions & 2 deletions doc/mpl_toolkits/axisartist/users/axisartist.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.. _axisartist-manual:

====================
AXISARTIST namespace
axisartist namespace
====================

The AxisArtist namespace includes a derived Axes implementation. The
The *axisartist* namespace includes a derived Axes implementation. The
biggest difference is that the artists responsible to draw axis line,
ticks, ticklabel and axis labels are separated out from the mpl's Axis
class, which are much more than artists in the original mpl. This
Expand Down