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

Skip to content

Commit cbb8e7d

Browse files
tacaswelltacaswell
committed
DOC: more section reorganization in axis docs
1 parent 650b640 commit cbb8e7d

1 file changed

Lines changed: 148 additions & 58 deletions

File tree

‎doc/api/axis_api.rst‎

Lines changed: 148 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,14 @@
77
:local:
88
:backlinks: entry
99

10-
1110
.. automodule:: matplotlib.axis
1211

12+
Inheritance
13+
===========
14+
15+
.. inheritance-diagram:: Tick Ticker XAxis YAxis XTick YTick
16+
:private-bases:
17+
1318

1419
``Axis`` objects
1520
================
@@ -20,77 +25,139 @@
2025
.. autoclass:: Ticker
2126

2227

23-
Methods
24-
-------
28+
.. autosummary::
29+
:toctree: _as_gen
30+
:nosignatures:
2531

26-
Axis
27-
~~~~
32+
Axis.cla
33+
Axis.get_scale
34+
35+
36+
Formatters and Locators
37+
-----------------------
2838

2939
.. autosummary::
3040
:toctree: _as_gen
3141
:nosignatures:
3242

43+
Axis.get_major_formatter
44+
Axis.get_major_locator
45+
Axis.get_minor_formatter
46+
Axis.get_minor_locator
47+
Axis.set_major_formatter
48+
Axis.set_major_locator
49+
Axis.set_minor_formatter
50+
Axis.set_minor_locator
3351

34-
Axis.OFFSETTEXTPAD
35-
Axis.axis_date
36-
Axis.cla
37-
Axis.convert_units
38-
Axis.get_data_interval
39-
Axis.get_gridlines
52+
53+
Axis Label
54+
----------
55+
56+
.. autosummary::
57+
:toctree: _as_gen
58+
:nosignatures:
59+
60+
Axis.set_label_coords
61+
Axis.set_label_position
62+
Axis.set_label_text
4063
Axis.get_label_position
4164
Axis.get_label_text
42-
Axis.get_major_formatter
43-
Axis.get_major_locator
65+
66+
Ticks, tick labels and Offset text
67+
----------------------------------
68+
69+
.. autosummary::
70+
:toctree: _as_gen
71+
:nosignatures:
72+
4473
Axis.get_major_ticks
4574
Axis.get_majorticklabels
4675
Axis.get_majorticklines
4776
Axis.get_majorticklocs
48-
Axis.get_minor_formatter
49-
Axis.get_minor_locator
5077
Axis.get_minor_ticks
5178
Axis.get_minorticklabels
5279
Axis.get_minorticklines
5380
Axis.get_minorticklocs
54-
Axis.get_minpos
81+
5582
Axis.get_offset_text
56-
Axis.get_pickradius
57-
Axis.get_scale
58-
Axis.get_smart_bounds
83+
5984
Axis.get_tick_padding
60-
Axis.get_tick_space
61-
Axis.get_ticklabel_extents
6285
Axis.get_ticklabels
6386
Axis.get_ticklines
6487
Axis.get_ticklocs
65-
Axis.get_tightbbox
66-
Axis.get_units
67-
Axis.get_view_interval
88+
89+
Axis.get_gridlines
6890
Axis.grid
91+
6992
Axis.iter_ticks
70-
Axis.limit_range_for_scale
71-
Axis.pan
72-
Axis.reset_ticks
93+
Axis.set_tick_params
94+
95+
Axis.axis_date
96+
97+
98+
Data and view internvals
99+
------------------------
100+
101+
.. autosummary::
102+
:toctree: _as_gen
103+
:nosignatures:
104+
105+
Axis.get_data_interval
106+
Axis.get_view_interval
73107
Axis.set_data_interval
74-
Axis.set_default_intervals
75-
Axis.set_label_coords
76-
Axis.set_label_position
77-
Axis.set_label_text
78-
Axis.set_major_formatter
79-
Axis.set_major_locator
80-
Axis.set_minor_formatter
81-
Axis.set_minor_locator
108+
Axis.set_view_interval
109+
110+
Rendering helpers
111+
-----------------
112+
113+
.. autosummary::
114+
:toctree: _as_gen
115+
:nosignatures:
116+
117+
Axis.get_minpos
118+
Axis.get_tick_space
119+
Axis.get_ticklabel_extents
120+
Axis.get_tightbbox
121+
122+
123+
Interactive
124+
-----------
125+
126+
.. autosummary::
127+
:toctree: _as_gen
128+
:nosignatures:
129+
130+
131+
Axis.get_pickradius
82132
Axis.set_pickradius
83-
Axis.set_smart_bounds
84-
Axis.set_tick_params
85-
Axis.set_ticklabels
86-
Axis.set_ticks
133+
134+
135+
Units
136+
-----
137+
138+
.. autosummary::
139+
:toctree: _as_gen
140+
:nosignatures:
141+
142+
Axis.convert_units
87143
Axis.set_units
88-
Axis.set_view_interval
144+
Axis.get_units
89145
Axis.update_units
146+
147+
148+
Incremental navigation
149+
----------------------
150+
151+
.. autosummary::
152+
:toctree: _as_gen
153+
:nosignatures:
154+
155+
Axis.pan
90156
Axis.zoom
91157

92-
YAxis
93-
~~~~~
158+
159+
YAxis Specific
160+
--------------
94161

95162
.. autosummary::
96163
:toctree: _as_gen
@@ -104,8 +171,9 @@ YAxis
104171
YAxis.tick_left
105172
YAxis.tick_right
106173

107-
XAxis
108-
~~~~~
174+
175+
XAxis Specific
176+
--------------
109177
.. autosummary::
110178
:toctree: _as_gen
111179
:nosignatures:
@@ -118,6 +186,38 @@ XAxis
118186
XAxis.tick_top
119187

120188

189+
Other
190+
-----
191+
192+
.. autosummary::
193+
:toctree: _as_gen
194+
:nosignatures:
195+
196+
197+
Axis.OFFSETTEXTPAD
198+
199+
Axis.limit_range_for_scale
200+
Axis.reset_ticks
201+
Axis.set_default_intervals
202+
Axis.get_smart_bounds
203+
Axis.set_smart_bounds
204+
205+
Discouraged
206+
-----------
207+
208+
These methods implicitly use `~matplotlib.ticker.FixedLocator` and
209+
`~matplotlib.ticker.FixedFormatter`. They can be convenient, but if
210+
not used together may de-couple your tick labels from your data.
211+
212+
.. autosummary::
213+
:toctree: _as_gen
214+
:nosignatures:
215+
216+
Axis.set_ticklabels
217+
Axis.set_ticks
218+
219+
220+
121221
``Tick`` objects
122222
================
123223

@@ -126,9 +226,6 @@ XAxis
126226
.. autoclass:: YTick
127227

128228

129-
Methods
130-
-------
131-
132229
.. autosummary::
133230
:toctree: _as_gen
134231
:nosignatures:
@@ -147,18 +244,11 @@ Methods
147244
Tick.update_position
148245

149246

150-
151-
Inheritance
152-
===========
153-
154-
.. inheritance-diagram:: Tick Ticker XAxis YAxis XTick YTick
155-
:private-bases:
156-
157247
Common and inherited methods
158248
============================
159249

160-
XTick
161-
-----
250+
``XTick``
251+
---------
162252

163253
.. autosummary::
164254
:toctree: _as_gen
@@ -265,8 +355,8 @@ YAxis
265355
YAxis.update_units
266356
YAxis.zoom
267357

268-
YAxis
269-
-----
358+
``YAxis``
359+
---------
270360

271361
.. autosummary::
272362
:toctree: _as_gen

0 commit comments

Comments
 (0)