Skip to content

Commit 7efe514

Browse files
committed
graph objects names, submodules
1 parent ac92b32 commit 7efe514

File tree

2 files changed

+284
-2
lines changed

2 files changed

+284
-2
lines changed

apidoc/graph_objects.rst

Lines changed: 250 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,254 @@
1-
GO
2-
===
1+
Graph objects: figures, traces and layout
2+
=========================================
3+
4+
.. currentmodule:: plotly.graph_objects
5+
6+
Classes
7+
8+
.. autosummary::
9+
10+
Area
11+
Bar
12+
Barpolar
13+
Box
14+
Candlestick
15+
Carpet
16+
Choropleth
17+
Choroplethmapbox
18+
Cone
19+
Contour
20+
Contourcarpet
21+
Densitymapbox
22+
Figure
23+
FigureWidget
24+
Frame
25+
Funnel
26+
Funnelarea
27+
Heatmap
28+
Heatmapgl
29+
Histogram
30+
Histogram2d
31+
Histogram2dContour
32+
Indicator
33+
Isosurface
34+
Layout
35+
Mesh3d
36+
Ohlc
37+
Parcats
38+
Parcoords
39+
Pie
40+
Pointcloud
41+
Sankey
42+
Scatter
43+
Scatter3d
44+
Scattercarpet
45+
Scattergeo
46+
Scattergl
47+
Scattermapbox
48+
Scatterpolar
49+
Scatterpolargl
50+
Scatterternary
51+
Splom
52+
Streamtube
53+
Sunburst
54+
Surface
55+
Table
56+
Violin
57+
Volume
58+
Waterfall
59+
60+
61+
Submodules
62+
63+
64+
.. autosummary::
65+
66+
area
67+
bar
68+
barpolar
69+
box
70+
candlestick
71+
carpet
72+
choropleth
73+
choroplethmapbox
74+
cone
75+
contour
76+
contourcarpet
77+
densitymapbox
78+
funnel
79+
funnelarea
80+
heatmap
81+
heatmapgl
82+
histogram
83+
histogram2d
84+
histogram2dcontour
85+
indicator
86+
isosurface
87+
layout
88+
mesh3d
89+
ohlc
90+
parcats
91+
parcoords
92+
pie
93+
pointcloud
94+
sankey
95+
scatter
96+
scatter3d
97+
scattercarpet
98+
scattergeo
99+
scattergl
100+
scattermapbox
101+
scatterpolar
102+
scatterpolargl
103+
scatterternary
104+
splom
105+
streamtube
106+
sunburst
107+
surface
108+
table
109+
violin
110+
volume
111+
waterfall
112+
3113

4114
.. automodule:: plotly.graph_objects
5115
:members:
6116

117+
.. automodule:: plotly.graph_objects.area
118+
:members:
119+
120+
.. automodule:: plotly.graph_objects.bar
121+
:members:
122+
123+
.. automodule:: plotly.graph_objects.barpolar
124+
:members:
125+
126+
.. automodule:: plotly.graph_objects.box
127+
:members:
128+
129+
.. automodule:: plotly.graph_objects.candlestick
130+
:members:
131+
132+
.. automodule:: plotly.graph_objects.carpet
133+
:members:
134+
135+
.. automodule:: plotly.graph_objects.choropleth
136+
:members:
137+
138+
.. automodule:: plotly.graph_objects.choroplethmapbox
139+
:members:
140+
141+
.. automodule:: plotly.graph_objects.cone
142+
:members:
143+
144+
.. automodule:: plotly.graph_objects.contour
145+
:members:
146+
147+
.. automodule:: plotly.graph_objects.contourcarpet
148+
:members:
149+
150+
.. automodule:: plotly.graph_objects.densitymapbox
151+
:members:
152+
153+
.. automodule:: plotly.graph_objects.funnel
154+
:members:
155+
156+
.. automodule:: plotly.graph_objects.funnelarea
157+
:members:
158+
159+
.. automodule:: plotly.graph_objects.heatmap
160+
:members:
161+
162+
.. automodule:: plotly.graph_objects.heatmapgl
163+
:members:
164+
165+
.. automodule:: plotly.graph_objects.histogram
166+
:members:
167+
168+
.. automodule:: plotly.graph_objects.histogram2d
169+
:members:
170+
171+
.. automodule:: plotly.graph_objects.histogram2dcontour
172+
:members:
173+
174+
.. automodule:: plotly.graph_objects.indicator
175+
:members:
176+
177+
.. automodule:: plotly.graph_objects.isosurface
178+
:members:
179+
180+
.. automodule:: plotly.graph_objects.layout
181+
:members:
182+
183+
.. automodule:: plotly.graph_objects.mesh3d
184+
:members:
185+
186+
.. automodule:: plotly.graph_objects.ohlc
187+
:members:
188+
189+
.. automodule:: plotly.graph_objects.parcats
190+
:members:
191+
192+
.. automodule:: plotly.graph_objects.parcoords
193+
:members:
194+
195+
.. automodule:: plotly.graph_objects.pie
196+
:members:
197+
198+
.. automodule:: plotly.graph_objects.pointcloud
199+
:members:
200+
201+
.. automodule:: plotly.graph_objects.sankey
202+
:members:
203+
204+
.. automodule:: plotly.graph_objects.scatter
205+
:members:
206+
207+
.. automodule:: plotly.graph_objects.scatter3d
208+
:members:
209+
210+
.. automodule:: plotly.graph_objects.scattercarpet
211+
:members:
212+
213+
.. automodule:: plotly.graph_objects.scattergeo
214+
:members:
215+
216+
.. automodule:: plotly.graph_objects.scattergl
217+
:members:
218+
219+
.. automodule:: plotly.graph_objects.scattermapbox
220+
:members:
221+
222+
.. automodule:: plotly.graph_objects.scatterpolar
223+
:members:
224+
225+
.. automodule:: plotly.graph_objects.scatterpolargl
226+
:members:
227+
228+
.. automodule:: plotly.graph_objects.scatterternary
229+
:members:
230+
231+
.. automodule:: plotly.graph_objects.splom
232+
:members:
233+
234+
.. automodule:: plotly.graph_objects.streamtube
235+
:members:
236+
237+
.. automodule:: plotly.graph_objects.sunburst
238+
:members:
239+
240+
.. automodule:: plotly.graph_objects.surface
241+
:members:
242+
243+
.. automodule:: plotly.graph_objects.table
244+
:members:
245+
246+
.. automodule:: plotly.graph_objects.violin
247+
:members:
248+
249+
.. automodule:: plotly.graph_objects.volume
250+
:members:
251+
252+
.. automodule:: plotly.graph_objects.waterfall
253+
:members:
254+

apidoc/helper_go_names.py

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
import inspect
2+
import plotly.graph_objects as go
3+
4+
members = inspect.getmembers(go)
5+
6+
functions, classes, submodules = [], [], []
7+
8+
for m in members:
9+
print(m)
10+
if m[0] not in go.__all__:
11+
continue
12+
if m[1].__doc__ and 'is deprecated' in m[1].__doc__:
13+
continue
14+
elif inspect.isfunction(m[1]):
15+
functions.append(m[0])
16+
elif inspect.isclass(m[1]):
17+
classes.append(m[0])
18+
elif inspect.ismodule(m[1]):
19+
submodules.append(m[0])
20+
21+
classes.sort()
22+
submodules.sort()
23+
24+
classes_str = "\n".join(classes)
25+
# print(classes_str)
26+
27+
submodules_str = "\n".join(submodules)
28+
# print(submodules_str)
29+
30+
autosubmodule = ''
31+
32+
for submodule in submodules:
33+
autosubmodule += '.. automodule:: plotly.graph_objects.%s\n :members:\n\n' %submodule
34+
print(autosubmodule)

0 commit comments

Comments
 (0)