Skip to content

Commit 5c12540

Browse files
committed
better layout
1 parent 61d6656 commit 5c12540

File tree

8 files changed

+162
-307
lines changed

8 files changed

+162
-307
lines changed

apidoc/_templates/class_figure.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,26 @@
11
:mod:`{{module}}`.{{objname}}
22
{{ underline }}==============
33

4-
Hello this is my template
54

65
.. currentmodule:: {{ module }}
76

87
.. autoclass:: {{ objname }}
9-
:inherited-members: update_layout
10-
:members: update_layout, add_traces
118

129
{% block methods %}
1310
.. automethod:: __init__
14-
.. automethod:: add_bar
11+
.. automethod:: show
1512
.. automethod:: update_layout
1613
.. automethod:: add_traces
1714
{% endblock %}
1815

16+
Other methods
17+
{{ underline }}==============
18+
19+
.. autosummary::
20+
:toctree: generated/
21+
22+
plotly.graph_objects.{{ objname }}
23+
1924

2025
.. raw:: html
2126

apidoc/_templates/trace.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
:mod:`{{module}}`.{{objname}}
2+
{{ underline }}
3+
4+
5+
.. currentmodule:: {{ module }}
6+
7+
.. autoclass:: {{ objname }}
8+
9+
{% block methods %}
10+
.. automethod:: __init__
11+
{% endblock %}
12+
13+
14+
:mod:`{{module}}`.{{objname.lower()}}
15+
{{ underline }}
16+
17+
.. autosummary::
18+
:toctree: generated/
19+
20+
plotly.graph_objects.{{ objname.lower() }}
21+
22+
.. automodule:: plotly.graph_objects.{{ objname.lower() }}
23+
:members:
24+
25+
26+
.. raw:: html
27+
28+
<div class="clearer"></div>

apidoc/colors.rst

Lines changed: 0 additions & 12 deletions
This file was deleted.

apidoc/conf.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,14 @@
4646
"sphinx.ext.todo",
4747
"sphinx.ext.coverage",
4848
"sphinx.ext.napoleon",
49+
4950
]
5051

5152
autosummary_generate = True
5253

5354
# Add any paths that contain templates here, relative to this directory.
54-
templates_path = ["_templates"]
55+
templates_path = ['_templates']
56+
5557

5658
# The suffix(es) of source filenames.
5759
# You can specify multiple suffix as a list of string:
@@ -90,7 +92,9 @@
9092
# further. For a list of options available for each theme, see the
9193
# documentation.
9294
#
93-
# html_theme_options = {}
95+
html_theme_options = {
96+
'analytics_id':'UA-39373211-1'
97+
}
9498

9599
# Add any paths that contain custom static files (such as style sheets) here,
96100
# relative to this directory. They are copied after the builtin static files,

apidoc/figure.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Figure
2+
======
3+
4+
.. currentmodule:: plotly.graph_objects
5+
6+
.. autosummary::
7+
:toctree: generated/
8+
9+
Figure
10+
11+
Figure.show
12+
Figure.update_layout
13+
Figure.add_traces
14+
15+
16+
.. autoclass:: Figure
17+
:members:

apidoc/graph_objects.rst

Lines changed: 85 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -9,118 +9,111 @@ Graph objects: figures, traces and layout
99

1010
>>> import plotly.graph_objects as go
1111

12+
.. toctree::
13+
:maxdepth: 1
14+
:caption: Figure:
1215

13-
Classes
16+
figure.rst
17+
18+
19+
Layout
20+
------
1421

1522
.. autosummary::
1623
:toctree: generated/
17-
:template: class_figure.rst
18-
19-
Figure
24+
:template: trace.rst
25+
26+
Layout
27+
28+
29+
30+
Simple charts
31+
--------------
2032

2133
.. autosummary::
2234
:toctree: generated/
23-
:template: class.rst
35+
:template: trace.rst
2436

25-
Area
37+
Scatter
38+
Scattergl
2639
Bar
27-
Barpolar
40+
Pie
41+
Heatmap
42+
Contour
43+
Table
44+
45+
Distributions
46+
-------------
47+
48+
.. autosummary::
49+
:toctree: generated/
50+
:template: trace.rst
51+
2852
Box
53+
Violin
54+
Histogram
55+
Histogram2d
56+
Histogram2dcontour
57+
58+
Finance
59+
-------
60+
61+
.. autosummary::
62+
:toctree: generated/
63+
:template: trace.rst
64+
65+
Ohlc
2966
Candlestick
30-
Carpet
31-
Choropleth
32-
Choroplethmapbox
33-
Cone
34-
Contour
35-
Contourcarpet
36-
Densitymapbox
37-
FigureWidget
38-
Frame
67+
Waterfall
3968
Funnel
4069
Funnelarea
41-
Heatmap
42-
Heatmapgl
43-
Histogram
44-
Histogram2d
45-
Histogram2dContour
4670
Indicator
47-
Isosurface
48-
Layout
49-
Mesh3d
50-
Ohlc
51-
Parcats
52-
Parcoords
53-
Pie
54-
Pointcloud
55-
Sankey
56-
Scatter
71+
72+
3D
73+
--
74+
75+
.. autosummary::
76+
:toctree: generated/
77+
:template: trace.rst
78+
5779
Scatter3d
58-
Scattercarpet
59-
Scattergeo
60-
Scattergl
61-
Scattermapbox
62-
Scatterpolar
63-
Scatterpolargl
64-
Scatterternary
65-
Splom
66-
Streamtube
67-
Sunburst
6880
Surface
69-
Table
70-
Violin
81+
Mesh3d
82+
Cone
83+
Streamtube
7184
Volume
72-
Waterfall
85+
Isosurface
86+
87+
Maps
88+
----
7389

90+
.. autosummary::
91+
:toctree: generated/
92+
:template: trace.rst
7493

75-
Submodules
94+
Scattergeo
95+
Choropleth
96+
Scattermapbox
97+
Choroplethmapbox
98+
Densitymapbox
7699

100+
Specialized
101+
-----------
77102

78103
.. autosummary::
104+
:toctree: generated/
105+
:template: trace.rst
79106

80-
area
81-
bar
82-
barpolar
83-
box
84-
candlestick
85-
carpet
86-
choropleth
87-
choroplethmapbox
88-
cone
89-
contour
90-
contourcarpet
91-
densitymapbox
92-
funnel
93-
funnelarea
94-
heatmap
95-
heatmapgl
96-
histogram
97-
histogram2d
98-
histogram2dcontour
99-
indicator
100-
isosurface
101-
layout
102-
mesh3d
103-
ohlc
104-
parcats
105-
parcoords
106-
pie
107-
pointcloud
108-
sankey
109-
scatter
110-
scatter3d
111-
scattercarpet
112-
scattergeo
113-
scattergl
114-
scattermapbox
115-
scatterpolar
116-
scatterpolargl
117-
scatterternary
118-
splom
119-
streamtube
120-
sunburst
121-
surface
122-
table
123-
violin
124-
volume
125-
waterfall
126-
107+
Scatterpolar
108+
Scatterpolargl
109+
Barpolar
110+
Scatterternary
111+
Sunburst
112+
Treemap
113+
Sankey
114+
Splom
115+
Parcats
116+
Parcoords
117+
Carpet
118+
Scattercarpet
119+
Contourcarpet

0 commit comments

Comments
 (0)