Skip to content

Commit 61d6656

Browse files
emmanuelleemmanuelle
committed
one page of doc per function of class
1 parent a12ed86 commit 61d6656

9 files changed

+260
-148
lines changed

‎apidoc/_templates/class.rst

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:mod:`{{module}}`.{{objname}}
2+
{{ underline }}==============
3+
4+
.. currentmodule:: {{ module }}
5+
6+
.. autoclass:: {{ objname }}
7+
8+
{% block methods %}
9+
.. automethod:: __init__
10+
{% endblock %}
11+
12+
13+
.. raw:: html
14+
15+
<div class="clearer"></div>

‎apidoc/_templates/class_figure.rst

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
:mod:`{{module}}`.{{objname}}
2+
{{ underline }}==============
3+
4+
Hello this is my template
5+
6+
.. currentmodule:: {{ module }}
7+
8+
.. autoclass:: {{ objname }}
9+
:inherited-members: update_layout
10+
:members: update_layout, add_traces
11+
12+
{% block methods %}
13+
.. automethod:: __init__
14+
.. automethod:: add_bar
15+
.. automethod:: update_layout
16+
.. automethod:: add_traces
17+
{% endblock %}
18+
19+
20+
.. raw:: html
21+
22+
<div class="clearer"></div>

‎apidoc/_templates/function.rst

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:mod:`{{module}}`.{{objname}}
2+
{{ underline }}====================
3+
4+
.. currentmodule:: {{ module }}
5+
6+
.. autofunction:: {{ objname }}
7+
8+
9+
.. raw:: html
10+
11+
<div class="clearer"></div>

‎apidoc/figure_factory.rst

+2-3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Figure Factory
44
.. currentmodule:: plotly.figure_factory
55

66
.. autosummary::
7+
:toctree: generated/
8+
:template: function.rst
79

810
create_2d_density
911
create_annotated_heatmap
@@ -22,6 +24,3 @@ Figure Factory
2224
create_trisurf
2325
create_violin
2426

25-
.. automodule:: plotly.figure_factory
26-
:members:
27-

‎apidoc/graph_objects.rst

+8-143
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ Graph objects: figures, traces and layout
1313
Classes
1414

1515
.. autosummary::
16+
:toctree: generated/
17+
:template: class_figure.rst
18+
19+
Figure
20+
21+
.. autosummary::
22+
:toctree: generated/
23+
:template: class.rst
1624

1725
Area
1826
Bar
@@ -26,7 +34,6 @@ Classes
2634
Contour
2735
Contourcarpet
2836
Densitymapbox
29-
Figure
3037
FigureWidget
3138
Frame
3239
Funnel
@@ -117,145 +124,3 @@ Submodules
117124
volume
118125
waterfall
119126

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

0 commit comments

Comments
 (0)