Skip to content

Commit ca63ff3

Browse files
LiamConnorsLiamConnors
committed
add generator script
1 parent f27f38f commit ca63ff3

File tree

3 files changed

+553
-0
lines changed

3 files changed

+553
-0
lines changed

‎docs/graph_objects_config.yaml‎

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
# Configuration for generating plotly.graph_objects reference pages
2+
# Based on the Sphinx autosummary structure
3+
4+
title: "plotly.graph_objects: low-level interface to figures, traces and layout"
5+
description: "plotly.graph_objects contains the building blocks of plotly Figure: traces and Layout"
6+
7+
sections:
8+
- name: "Figure"
9+
description: ""
10+
items:
11+
- name: "Figure"
12+
type: "class"
13+
options:
14+
merge_init_into_class: true
15+
inherited_members: true
16+
17+
- name: "Layout"
18+
description: ""
19+
items:
20+
- name: "Layout"
21+
type: "class"
22+
23+
- name: "Simple Traces"
24+
description: ""
25+
items:
26+
- name: "Scatter"
27+
type: "trace"
28+
- name: "Scattergl"
29+
type: "trace"
30+
- name: "Bar"
31+
type: "trace"
32+
- name: "Pie"
33+
type: "trace"
34+
- name: "Heatmap"
35+
type: "trace"
36+
- name: "Image"
37+
type: "trace"
38+
- name: "Contour"
39+
type: "trace"
40+
- name: "Table"
41+
type: "trace"
42+
43+
- name: "Distribution Traces"
44+
description: ""
45+
items:
46+
- name: "Box"
47+
type: "trace"
48+
- name: "Violin"
49+
type: "trace"
50+
- name: "Histogram"
51+
type: "trace"
52+
- name: "Histogram2d"
53+
type: "trace"
54+
- name: "Histogram2dContour"
55+
type: "trace"
56+
57+
- name: "Finance Traces"
58+
description: ""
59+
items:
60+
- name: "Ohlc"
61+
type: "trace"
62+
- name: "Candlestick"
63+
type: "trace"
64+
- name: "Waterfall"
65+
type: "trace"
66+
- name: "Funnel"
67+
type: "trace"
68+
- name: "Funnelarea"
69+
type: "trace"
70+
- name: "Indicator"
71+
type: "trace"
72+
73+
- name: "3D Traces"
74+
description: ""
75+
items:
76+
- name: "Scatter3d"
77+
type: "trace"
78+
- name: "Surface"
79+
type: "trace"
80+
- name: "Mesh3d"
81+
type: "trace"
82+
- name: "Cone"
83+
type: "trace"
84+
- name: "Streamtube"
85+
type: "trace"
86+
- name: "Volume"
87+
type: "trace"
88+
- name: "Isosurface"
89+
type: "trace"
90+
91+
- name: "Map Traces"
92+
description: ""
93+
items:
94+
- name: "Scattergeo"
95+
type: "trace"
96+
- name: "Choropleth"
97+
type: "trace"
98+
- name: "Scattermap"
99+
type: "trace"
100+
- name: "Choroplethmap"
101+
type: "trace"
102+
- name: "Densitymap"
103+
type: "trace"
104+
- name: "Scattermapbox"
105+
type: "trace"
106+
- name: "Choroplethmapbox"
107+
type: "trace"
108+
- name: "Densitymapbox"
109+
type: "trace"
110+
111+
- name: "Specialized Traces"
112+
description: ""
113+
items:
114+
- name: "Scatterpolar"
115+
type: "trace"
116+
- name: "Scatterpolargl"
117+
type: "trace"
118+
- name: "Barpolar"
119+
type: "trace"
120+
- name: "Scatterternary"
121+
type: "trace"
122+
- name: "Sunburst"
123+
type: "trace"
124+
- name: "Treemap"
125+
type: "trace"
126+
- name: "Icicle"
127+
type: "trace"
128+
- name: "Sankey"
129+
type: "trace"
130+
- name: "Splom"
131+
type: "trace"
132+
- name: "Parcats"
133+
type: "trace"
134+
- name: "Parcoords"
135+
type: "trace"
136+
- name: "Carpet"
137+
type: "trace"
138+
- name: "Scattercarpet"
139+
type: "trace"
140+
- name: "Contourcarpet"
141+
type: "trace"
142+

‎mkdocs.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
site_name: Plotly.py Graphing Library
2+
site_url: https://plotly.com/python
3+
site_description: Plotly's Python graphing library makes interactive, publication-quality graphs.
4+
5+
repo_name: plotly/plotly.py
6+
repo_url: https://github.com/plotly/plotly.py
7+
8+
theme:
9+
name: material
10+
custom_dir: docs/overrides
11+
logo: assets/images/logo.svg
12+
palette:
13+
primary: custom
14+
accent: custom
15+
features:
16+
- navigation.top
17+
- navigation.path
18+
19+
extra_css:
20+
- assets/stylesheets/plotly-style.css
21+
22+
hooks:
23+
- scripts/generate_graph_objects_docs.py
24+
25+
plugins:
26+
27+
- search
28+
- mkdocstrings:
29+
default_handler: python
30+
handlers:
31+
python:
32+
paths: [plotly]
33+
options:
34+
preload_modules:
35+
- _plotly_utils
36+
heading_level: 3
37+
show_bases: false
38+
show_symbol_type_heading: true
39+
docstring_style: numpy
40+
merge_init_into_class: true
41+
filters: ["!^_"]
42+
43+
nav:
44+
45+
- API Reference:
46+
- plotly.express: reference/plotly_express/index.md
47+
- plotly.graph_objects: reference/graph_objects/index.md
48+
- plotly.io: reference/plotly_io.md
49+
- plotly.data: reference/plotly_data.md
50+
- plotly.colors: reference/plotly_colors.md
51+
- plotly.subplots: reference/plotly_subplots.md
52+
- plotly.figure_factory: reference/plotly_figure_factory.md
53+
54+
- Community Forum: http://community.plotly.com/

0 commit comments

Comments
 (0)