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

Skip to content

Commit f59e21d

Browse files
NelleVNelleV
authored
Merge pull request #7176 from tacaswell/doc_organize_axes_docs
DOC organize axes docs
2 parents c0c65e3 + 58b4dbd commit f59e21d

File tree

10 files changed

+1926
-98
lines changed

10 files changed

+1926
-98
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ doc/_templates/gallery.html
6262
doc/users/installing.rst
6363
doc/_static/matplotlibrc
6464
doc/pyplots/tex_demo.png
65+
doc/api/_as_gen
6566
lib/dateutil
6667
examples/*/*.pdf
6768
examples/*/*.png

‎doc/_static/mpl.css

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
body {
77
font-family: "Helvetica Neue", Helvetica, 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', 'Verdana', sans-serif;
88
font-size: 14px;
9-
letter-spacing: -0.01em;
109
line-height: 150%;
1110
text-align: center;
1211
background-color: #BFD1D4;
@@ -272,7 +271,7 @@ h2 {
272271
}
273272

274273
h3 {
275-
margin: 1em 0 -0.3em 0;
274+
margin: 0.2em 0 0.1em 0;
276275
font-size: 1.2em;
277276
}
278277

@@ -513,19 +512,13 @@ table.docutils {
513512
.longtable.docutils {
514513
font-size: 12px;
515514
margin-bottom: 30px;
516-
background-color: #ccc;
517515
}
518516
.longtable.docutils, .longtable.docutils td {
519517
border-color: #ccc;
520518
}
521519

522-
/* module summary table */
523-
.longtable.docutils {
524-
font-size: 12px;
525-
margin-bottom: 30px;
526-
}
527-
.longtable.docutils, .longtable.docutils td {
528-
border-color: #ccc;
520+
.longtable.docutils tr.row-even{
521+
background-color: #eff3f4;
529522
}
530523

531524
/* function and class description */
@@ -560,16 +553,20 @@ dl.class dd, dl.function dd {
560553
}
561554

562555
/* function and class description */
563-
dl.class, dl.function, dl.method, dl.attribute {
556+
dl.function, dl.method, dl.attribute {
564557
border-top: 1px solid #ccc;
565558
padding-top: 6px;
566559
}
567560

568-
dl.class, dl.function {
561+
dl.function {
569562
border-top: 1px solid #888;
570-
margin-top: 15px;
563+
margin-top: 15px;
571564
}
572565

566+
dl.class {
567+
padding-top: 6px;
568+
margin-top: 15px;
569+
}
573570

574571
.descclassname {
575572
color: #aaa;
@@ -705,7 +702,7 @@ div.responsive_subfig{
705702

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

711708
div.responsive_subfig img {

‎doc/api/artist_api.rst

Lines changed: 209 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,216 @@
11
.. _artist-api:
22

3-
*******
4-
artists
5-
*******
3+
===================
4+
``artist`` Module
5+
===================
66

7-
.. inheritance-diagram:: matplotlib.patches matplotlib.lines matplotlib.text matplotlib.offsetbox matplotlib.image
8-
:parts: 2
7+
.. 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
8+
:parts: 1
99
:private-bases:
1010

11-
:mod:`matplotlib.artist`
12-
========================
11+
1312

1413
.. automodule:: matplotlib.artist
15-
:members:
16-
:undoc-members:
17-
:show-inheritance:
14+
15+
16+
``Artist`` class
17+
================
18+
19+
20+
Interactive
21+
-----------
22+
23+
.. autosummary::
24+
:toctree: _as_gen
25+
:nosignatures:
26+
27+
Artist.add_callback
28+
Artist.format_cursor_data
29+
Artist.get_contains
30+
Artist.get_cursor_data
31+
Artist.get_picker
32+
Artist.hitlist
33+
Artist.mouseover
34+
Artist.pchanged
35+
Artist.pick
36+
Artist.pickable
37+
Artist.remove_callback
38+
Artist.set_contains
39+
Artist.set_picker
40+
Artist.contains
41+
42+
43+
Margins and Autoscaling
44+
-----------------------
45+
46+
.. autosummary::
47+
:toctree: _as_gen
48+
:nosignatures:
49+
50+
Artist.get_bottom_margin
51+
Artist.get_left_margin
52+
Artist.get_margins
53+
Artist.get_top_margin
54+
Artist.margins
55+
Artist.left_margin
56+
Artist.get_right_margin
57+
Artist.bottom_margin
58+
Artist.right_margin
59+
Artist.set_bottom_margin
60+
Artist.set_left_margin
61+
Artist.set_margins
62+
Artist.set_right_margin
63+
Artist.set_top_margin
64+
Artist.top_margin
65+
66+
Clipping
67+
--------
68+
69+
.. autosummary::
70+
:toctree: _as_gen
71+
:nosignatures:
72+
73+
Artist.get_clip_box
74+
Artist.get_clip_on
75+
Artist.get_clip_path
76+
Artist.set_clip_box
77+
Artist.set_clip_on
78+
Artist.set_clip_path
79+
80+
Bulk Properties
81+
---------------
82+
83+
.. autosummary::
84+
:toctree: _as_gen
85+
:nosignatures:
86+
87+
Artist.update
88+
Artist.update_from
89+
Artist.properties
90+
Artist.set
91+
92+
93+
Drawing
94+
-------
95+
96+
.. autosummary::
97+
:toctree: _as_gen
98+
:nosignatures:
99+
100+
Artist.draw
101+
Artist.get_animated
102+
Artist.set_animated
103+
104+
Artist.get_agg_filter
105+
106+
Artist.get_alpha
107+
Artist.get_snap
108+
Artist.get_visible
109+
Artist.get_zorder
110+
Artist.set_agg_filter
111+
Artist.set_alpha
112+
113+
Artist.set_sketch_params
114+
Artist.set_snap
115+
Artist.get_rasterized
116+
Artist.get_sketch_params
117+
Artist.set_path_effects
118+
Artist.set_rasterized
119+
Artist.zorder
120+
Artist.set_visible
121+
Artist.set_zorder
122+
Artist.get_window_extent
123+
Artist.get_path_effects
124+
Artist.get_transformed_clip_path_and_affine
125+
126+
127+
128+
Figure and Axes
129+
---------------
130+
131+
.. autosummary::
132+
:toctree: _as_gen
133+
:nosignatures:
134+
135+
Artist.remove
136+
137+
Artist.axes
138+
Artist.get_axes
139+
Artist.set_axes
140+
141+
Artist.set_figure
142+
Artist.get_figure
143+
Artist.is_figure_set
144+
145+
Children
146+
--------
147+
148+
.. autosummary::
149+
:toctree: _as_gen
150+
:nosignatures:
151+
152+
Artist.get_children
153+
Artist.findobj
154+
155+
156+
Transform
157+
---------
158+
159+
.. autosummary::
160+
:toctree: _as_gen
161+
:nosignatures:
162+
163+
Artist.set_transform
164+
Artist.get_transform
165+
Artist.is_transform_set
166+
167+
168+
169+
Units
170+
-----
171+
172+
.. autosummary::
173+
:toctree: _as_gen
174+
:nosignatures:
175+
176+
Artist.convert_xunits
177+
Artist.convert_yunits
178+
Artist.have_units
179+
180+
Metadata
181+
--------
182+
183+
.. autosummary::
184+
:toctree: _as_gen
185+
:nosignatures:
186+
187+
Artist.get_gid
188+
Artist.get_label
189+
Artist.set_gid
190+
Artist.set_label
191+
Artist.get_url
192+
Artist.set_url
193+
Artist.aname
194+
195+
Stale
196+
-----
197+
198+
.. autosummary::
199+
:toctree: _as_gen
200+
:nosignatures:
201+
202+
Artist.stale
203+
204+
Functions
205+
=========
206+
207+
.. autosummary::
208+
:toctree: _as_gen
209+
:nosignatures:
210+
211+
allow_rasterization
212+
get
213+
getp
214+
setp
215+
kwdoc
216+
ArtistInspector

0 commit comments

Comments
 (0)