Skip to content

Commit 81b723b

Browse files
CSSFrancisCSSFrancis
committed
Enhance documentation: update API reference and add detailed summaries for callbacks, figures, markers, and widgets
1 parent a695de0 commit 81b723b

7 files changed

Lines changed: 449 additions & 7 deletions

File tree

‎docs/_templates/autosummary/class.rst‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{{ fullname | escape | underline}}
2+
3+
.. currentmodule:: {{ module }}
4+
5+
.. autoclass:: {{ objname }}
6+
:show-inheritance:
7+
8+
{% block methods %}
9+
{% if methods %}
10+
.. rubric:: Methods
11+
12+
.. autosummary::
13+
:nosignatures:
14+
15+
{% for item in methods %}
16+
~{{ fullname }}.{{ item }}
17+
{%- endfor %}
18+
19+
{% endif %}
20+
{% endblock %}
21+
22+
{% block attributes %}
23+
{% if attributes %}
24+
.. rubric:: Attributes
25+
26+
.. autosummary::
27+
:nosignatures:
28+
29+
{% for item in attributes %}
30+
~{{ fullname }}.{{ item }}
31+
{%- endfor %}
32+
33+
{% endif %}
34+
{% endblock %}

‎docs/api/callbacks.rst‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,31 @@
1+
=========
12
Callbacks
23
=========
34

45
.. automodule:: anyplotlib.callbacks
6+
:no-members:
7+
:no-undoc-members:
8+
9+
.. currentmodule:: anyplotlib
10+
11+
.. rubric:: Classes
12+
13+
.. autosummary::
14+
:nosignatures:
15+
16+
CallbackRegistry
17+
Event
18+
19+
.. rubric:: Full Reference
20+
21+
.. autoclass:: anyplotlib.callbacks.CallbackRegistry
522
:members:
6-
:undoc-members: False
723
:show-inheritance:
824
:member-order: bysource
25+
:no-index:
926

27+
.. autoclass:: anyplotlib.callbacks.Event
28+
:members:
29+
:show-inheritance:
30+
:member-order: bysource
31+
:no-index:

‎docs/api/figure.rst‎

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,34 @@
1+
======
12
Figure
23
======
34

45
.. automodule:: anyplotlib.figure
6+
:no-members:
7+
:no-undoc-members:
8+
9+
.. currentmodule:: anyplotlib
10+
11+
.. rubric:: Classes
12+
13+
.. autosummary::
14+
:nosignatures:
15+
16+
Figure
17+
18+
.. rubric:: Functions
19+
20+
.. autosummary::
21+
:nosignatures:
22+
23+
subplots
24+
25+
.. rubric:: Full Reference
26+
27+
.. autoclass:: anyplotlib.figure.Figure
528
:members:
6-
:undoc-members: False
729
:show-inheritance:
830
:member-order: bysource
31+
:no-index:
32+
33+
.. autofunction:: anyplotlib.figure.subplots
34+
:no-index:

‎docs/api/figure_plots.rst‎

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,85 @@
1+
============
12
Figure Plots
23
============
34

45
.. automodule:: anyplotlib.figure_plots
6+
:no-members:
7+
:no-undoc-members:
8+
9+
.. currentmodule:: anyplotlib
10+
11+
.. rubric:: Axes
12+
13+
.. autosummary::
14+
:nosignatures:
15+
16+
Axes
17+
18+
.. rubric:: Plot Classes
19+
20+
.. autosummary::
21+
:nosignatures:
22+
23+
Plot1D
24+
Plot2D
25+
PlotMesh
26+
Plot3D
27+
PlotBar
28+
29+
.. rubric:: Layout
30+
31+
.. autosummary::
32+
:nosignatures:
33+
34+
GridSpec
35+
SubplotSpec
36+
37+
.. rubric:: Full Reference
38+
39+
.. autoclass:: anyplotlib.figure_plots.Axes
40+
:members:
41+
:show-inheritance:
42+
:member-order: bysource
43+
:no-index:
44+
45+
.. autoclass:: anyplotlib.figure_plots.Plot1D
46+
:members:
47+
:show-inheritance:
48+
:member-order: bysource
49+
:no-index:
50+
51+
.. autoclass:: anyplotlib.figure_plots.Plot2D
52+
:members:
53+
:show-inheritance:
54+
:member-order: bysource
55+
:no-index:
56+
57+
.. autoclass:: anyplotlib.figure_plots.PlotMesh
58+
:members:
59+
:show-inheritance:
60+
:member-order: bysource
61+
:no-index:
62+
63+
.. autoclass:: anyplotlib.figure_plots.Plot3D
64+
:members:
65+
:show-inheritance:
66+
:member-order: bysource
67+
:no-index:
68+
69+
.. autoclass:: anyplotlib.figure_plots.PlotBar
70+
:members:
71+
:show-inheritance:
72+
:member-order: bysource
73+
:no-index:
74+
75+
.. autoclass:: anyplotlib.figure_plots.GridSpec
576
:members:
6-
:undoc-members: False
777
:show-inheritance:
878
:member-order: bysource
79+
:no-index:
980

81+
.. autoclass:: anyplotlib.figure_plots.SubplotSpec
82+
:members:
83+
:show-inheritance:
84+
:member-order: bysource
85+
:no-index:

‎docs/api/index.rst‎

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,182 @@
1+
=============
12
API Reference
23
=============
34

5+
The anyplotlib public API is organized into five modules below.
6+
Click a card to browse the module page, or use the summary tables to jump
7+
directly to a class or function.
8+
49
.. toctree::
10+
:hidden:
511
:maxdepth: 2
612

713
figure
814
figure_plots
915
markers
1016
widgets
1117
callbacks
18+
19+
.. grid:: 2 3 3 3
20+
:gutter: 2
21+
22+
.. grid-item-card::
23+
:link: figure
24+
:link-type: doc
25+
26+
:octicon:`browser;2em;sd-text-info` Figure
27+
^^^
28+
29+
The :class:`~anyplotlib.Figure` widget and the
30+
:func:`~anyplotlib.subplots` factory — the main entry point
31+
for creating interactive figures.
32+
33+
.. grid-item-card::
34+
:link: figure_plots
35+
:link-type: doc
36+
37+
:octicon:`graph;2em;sd-text-info` Axes & Plots
38+
^^^
39+
40+
:class:`~anyplotlib.Axes` and the five plot classes:
41+
:class:`~anyplotlib.Plot1D`, :class:`~anyplotlib.Plot2D`,
42+
:class:`~anyplotlib.PlotMesh`, :class:`~anyplotlib.Plot3D`,
43+
:class:`~anyplotlib.PlotBar`.
44+
45+
.. grid-item-card::
46+
:link: figure_plots
47+
:link-type: doc
48+
49+
:octicon:`rows;2em;sd-text-info` Layout
50+
^^^
51+
52+
:class:`~anyplotlib.GridSpec` and :class:`~anyplotlib.SubplotSpec`
53+
for building flexible multi-panel figure layouts.
54+
55+
.. grid-item-card::
56+
:link: markers
57+
:link-type: doc
58+
59+
:octicon:`dot-fill;2em;sd-text-info` Markers
60+
^^^
61+
62+
Static visual overlays — circles, arrows, lines, rectangles,
63+
polygons, text, and more — drawn on top of any plot.
64+
65+
.. grid-item-card::
66+
:link: widgets
67+
:link-type: doc
68+
69+
:octicon:`sliders;2em;sd-text-info` Interactive Widgets
70+
^^^
71+
72+
Draggable overlays such as :class:`~anyplotlib.CrosshairWidget`
73+
and :class:`~anyplotlib.RectangleWidget` that report position
74+
back to Python.
75+
76+
.. grid-item-card::
77+
:link: callbacks
78+
:link-type: doc
79+
80+
:octicon:`bell;2em;sd-text-info` Callbacks
81+
^^^
82+
83+
The :class:`~anyplotlib.CallbackRegistry` two-tier event system
84+
(``on_change`` for live frames, ``on_release`` for settled state)
85+
and the :class:`~anyplotlib.Event` dataclass.
86+
87+
88+
Figure
89+
------
90+
91+
.. currentmodule:: anyplotlib
92+
93+
.. autosummary::
94+
:toctree: generated/
95+
:nosignatures:
96+
:template: class.rst
97+
98+
Figure
99+
100+
.. autosummary::
101+
:toctree: generated/
102+
:nosignatures:
103+
104+
subplots
105+
106+
107+
Axes & Plots
108+
------------
109+
110+
.. autosummary::
111+
:toctree: generated/
112+
:nosignatures:
113+
:template: class.rst
114+
115+
Axes
116+
Plot1D
117+
Plot2D
118+
PlotMesh
119+
Plot3D
120+
PlotBar
121+
122+
123+
Layout
124+
------
125+
126+
.. autosummary::
127+
:toctree: generated/
128+
:nosignatures:
129+
:template: class.rst
130+
131+
GridSpec
132+
SubplotSpec
133+
134+
135+
Markers
136+
-------
137+
138+
.. currentmodule:: anyplotlib.markers
139+
140+
.. autosummary::
141+
:toctree: generated/
142+
:nosignatures:
143+
:template: class.rst
144+
145+
MarkerGroup
146+
MarkerTypeDict
147+
MarkerRegistry
148+
149+
150+
Interactive Widgets
151+
-------------------
152+
153+
.. currentmodule:: anyplotlib
154+
155+
.. autosummary::
156+
:toctree: generated/
157+
:nosignatures:
158+
:template: class.rst
159+
160+
Widget
161+
RectangleWidget
162+
CircleWidget
163+
AnnularWidget
164+
CrosshairWidget
165+
PolygonWidget
166+
LabelWidget
167+
VLineWidget
168+
HLineWidget
169+
RangeWidget
170+
171+
172+
Callbacks
173+
---------
174+
175+
.. autosummary::
176+
:toctree: generated/
177+
:nosignatures:
178+
:template: class.rst
179+
180+
CallbackRegistry
181+
Event
182+

0 commit comments

Comments
 (0)