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

Skip to content

Doc organize axes docs #7176

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 14 commits into from
Sep 29, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ doc/_templates/gallery.html
doc/users/installing.rst
doc/_static/matplotlibrc
doc/pyplots/tex_demo.png
doc/api/_as_gen
lib/dateutil
examples/*/*.pdf
examples/*/*.png
Expand Down
25 changes: 11 additions & 14 deletions doc/_static/mpl.css
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
body {
font-family: "Helvetica Neue", Helvetica, 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', 'Verdana', sans-serif;
font-size: 14px;
letter-spacing: -0.01em;
line-height: 150%;
text-align: center;
background-color: #BFD1D4;
Expand Down Expand Up @@ -272,7 +271,7 @@ h2 {
}

h3 {
margin: 1em 0 -0.3em 0;
margin: 0.2em 0 0.1em 0;
font-size: 1.2em;
}

Expand Down Expand Up @@ -513,19 +512,13 @@ table.docutils {
.longtable.docutils {
font-size: 12px;
margin-bottom: 30px;
background-color: #ccc;
}
.longtable.docutils, .longtable.docutils td {
border-color: #ccc;
}

/* module summary table */
.longtable.docutils {
font-size: 12px;
margin-bottom: 30px;
}
.longtable.docutils, .longtable.docutils td {
border-color: #ccc;
.longtable.docutils tr.row-even{
background-color: #eff3f4;
}

/* function and class description */
Expand Down Expand Up @@ -560,16 +553,20 @@ dl.class dd, dl.function dd {
}

/* function and class description */
dl.class, dl.function, dl.method, dl.attribute {
dl.function, dl.method, dl.attribute {
border-top: 1px solid #ccc;
padding-top: 6px;
}

dl.class, dl.function {
dl.function {
border-top: 1px solid #888;
margin-top: 15px;
margin-top: 15px;
}

dl.class {
padding-top: 6px;
margin-top: 15px;
}

.descclassname {
color: #aaa;
Expand Down Expand Up @@ -705,7 +702,7 @@ div.responsive_subfig{

/* Include content, padding and border in width. This should */
/* avoid having to use tricks like "width: 24.9999%" */
box-sizing: border-box;
box-sizing: border-box;
}

div.responsive_subfig img {
Expand Down
219 changes: 209 additions & 10 deletions doc/api/artist_api.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,216 @@
.. _artist-api:

*******
artists
*******
===================
``artist`` Module
===================

.. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text matplotlib.offsetbox matplotlib.image
:parts: 2
.. inheritance-diagram:: matplotlib.axes._axes.Axes matplotlib.axes._base._AxesBase matplotlib.axis.Axis matplotlib.axis.Tick matplotlib.axis.XAxis matplotlib.axis.XTick matplotlib.axis.YAxis matplotlib.axis.YTick matplotlib.collections.AsteriskPolygonCollection matplotlib.collections.BrokenBarHCollection matplotlib.collections.CircleCollection matplotlib.collections.Collection matplotlib.collections.EllipseCollection matplotlib.collections.EventCollection matplotlib.collections.LineCollection matplotlib.collections.PatchCollection matplotlib.collections.PathCollection matplotlib.collections.PolyCollection matplotlib.collections.QuadMesh matplotlib.collections.RegularPolyCollection matplotlib.collections.StarPolygonCollection matplotlib.collections.TriMesh matplotlib.collections._CollectionWithSizes matplotlib.contour.ClabelText matplotlib.figure.Figure matplotlib.image.AxesImage matplotlib.image.BboxImage matplotlib.image.FigureImage matplotlib.image.NonUniformImage matplotlib.image.PcolorImage matplotlib.image._ImageBase matplotlib.legend.Legend matplotlib.lines.Line2D matplotlib.offsetbox.AnchoredOffsetbox matplotlib.offsetbox.AnchoredText matplotlib.offsetbox.AnnotationBbox matplotlib.offsetbox.AuxTransformBox matplotlib.offsetbox.DrawingArea matplotlib.offsetbox.HPacker matplotlib.offsetbox.OffsetBox matplotlib.offsetbox.OffsetImage matplotlib.offsetbox.PackerBase matplotlib.offsetbox.PaddedBox matplotlib.offsetbox.TextArea matplotlib.offsetbox.VPacker matplotlib.patches.Arc matplotlib.patches.Arrow matplotlib.patches.Circle matplotlib.patches.CirclePolygon matplotlib.patches.ConnectionPatch matplotlib.patches.Ellipse matplotlib.patches.FancyArrow matplotlib.patches.FancyArrowPatch matplotlib.patches.FancyBboxPatch matplotlib.patches.Patch matplotlib.patches.PathPatch matplotlib.patches.Polygon matplotlib.patches.Rectangle matplotlib.patches.RegularPolygon matplotlib.patches.Shadow matplotlib.patches.Wedge matplotlib.patches.YAArrow matplotlib.projections.geo.AitoffAxes matplotlib.projections.geo.GeoAxes matplotlib.projections.geo.HammerAxes matplotlib.projections.geo.LambertAxes matplotlib.projections.geo.MollweideAxes matplotlib.projections.polar.PolarAxes matplotlib.quiver.Barbs matplotlib.quiver.Quiver matplotlib.quiver.QuiverKey matplotlib.spines.Spine matplotlib.table.Cell matplotlib.table.CustomCell matplotlib.table.Table matplotlib.text.Annotation matplotlib.text.Text matplotlib.text.TextWithDash
:parts: 1
:private-bases:

:mod:`matplotlib.artist`
========================


.. automodule:: matplotlib.artist
:members:
:undoc-members:
:show-inheritance:


``Artist`` class
================


Interactive
-----------

.. autosummary::
:toctree: _as_gen
:nosignatures:

Artist.add_callback
Artist.format_cursor_data
Artist.get_contains
Artist.get_cursor_data
Artist.get_picker
Artist.hitlist
Artist.mouseover
Artist.pchanged
Artist.pick
Artist.pickable
Artist.remove_callback
Artist.set_contains
Artist.set_picker
Artist.contains


Margins and Autoscaling
-----------------------

.. autosummary::
:toctree: _as_gen
:nosignatures:

Artist.get_bottom_margin
Artist.get_left_margin
Artist.get_margins
Artist.get_top_margin
Artist.margins
Artist.left_margin
Artist.get_right_margin
Artist.bottom_margin
Artist.right_margin
Artist.set_bottom_margin
Artist.set_left_margin
Artist.set_margins
Artist.set_right_margin
Artist.set_top_margin
Artist.top_margin

Clipping
--------

.. autosummary::
:toctree: _as_gen
:nosignatures:

Artist.get_clip_box
Artist.get_clip_on
Artist.get_clip_path
Artist.set_clip_box
Artist.set_clip_on
Artist.set_clip_path

Bulk Properties
---------------

.. autosummary::
:toctree: _as_gen
:nosignatures:

Artist.update
Artist.update_from
Artist.properties
Artist.set


Drawing
-------

.. autosummary::
:toctree: _as_gen
:nosignatures:

Artist.draw
Artist.get_animated
Artist.set_animated

Artist.get_agg_filter

Artist.get_alpha
Artist.get_snap
Artist.get_visible
Artist.get_zorder
Artist.set_agg_filter
Artist.set_alpha

Artist.set_sketch_params
Artist.set_snap
Artist.get_rasterized
Artist.get_sketch_params
Artist.set_path_effects
Artist.set_rasterized
Artist.zorder
Artist.set_visible
Artist.set_zorder
Artist.get_window_extent
Artist.get_path_effects
Artist.get_transformed_clip_path_and_affine



Figure and Axes
---------------

.. autosummary::
:toctree: _as_gen
:nosignatures:

Artist.remove

Artist.axes
Artist.get_axes
Artist.set_axes

Artist.set_figure
Artist.get_figure
Artist.is_figure_set

Children
--------

.. autosummary::
:toctree: _as_gen
:nosignatures:

Artist.get_children
Artist.findobj


Transform
---------

.. autosummary::
:toctree: _as_gen
:nosignatures:

Artist.set_transform
Artist.get_transform
Artist.is_transform_set



Units
-----

.. autosummary::
:toctree: _as_gen
:nosignatures:

Artist.convert_xunits
Artist.convert_yunits
Artist.have_units

Metadata
--------

.. autosummary::
:toctree: _as_gen
:nosignatures:

Artist.get_gid
Artist.get_label
Artist.set_gid
Artist.set_label
Artist.get_url
Artist.set_url
Artist.aname

Stale
-----

.. autosummary::
:toctree: _as_gen
:nosignatures:

Artist.stale

Functions
=========

.. autosummary::
:toctree: _as_gen
:nosignatures:

allow_rasterization
get
getp
setp
kwdoc
ArtistInspector
Loading