Skip to content

Commit 35cbdf6

Browse files
nicolaskruchtennicolaskruchten
committed
add Julia reference pages
1 parent 86c895e commit 35cbdf6

File tree

65 files changed

+1227
-45
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+1227
-45
lines changed

‎_data/make_ref_pages.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
schema = json.load(open("plotschema.json"))
44

55

6-
for upperlang in ["Python", "JavaScript", "MATLAB", "R"]:
6+
for upperlang in ["Python", "JavaScript", "MATLAB", "R", "Julia"]:
77
lang = upperlang.lower()
88
langcode = "plotly_js" if lang == "javascript" else lang
99
for attr in [

‎_includes/layouts/side-bar.html‎

Lines changed: 35 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -103,63 +103,36 @@
103103
<nav class="--sidebar-body watch" id="where">
104104
<ul class="--sidebar-list">
105105
<!-- Getting Started -->
106-
{% if page.language == "plotly_js" %}
107-
<li class="--sidebar-item">
108-
<a href="/javascript/getting-started" class="js-splash--navigation-item">Getting Started</a>
109-
</li>
110-
{% else %}
111106
<li class="--sidebar-item">
112-
<a href="/{{ page.language }}/getting-started" class="js-splash--navigation-item">Getting Started</a>
107+
<a href="/{{ langue }}/getting-started" class="js-splash--navigation-item">Getting Started</a>
113108
</li>
114-
{% endif %}
115-
{% if page.language == "r" or page.language == "python" %}
116-
<li class="--sidebar-item">
117-
<a href="/{{ page.language }}/is-plotly-free" class="js-splash--navigation-item">Is Plotly Free?</a>
118-
</li>
119-
{% endif %}
120-
{% if page.language == "plotly_js" %}
121-
<li class="--sidebar-item">
122-
<a href="/javascript/is-plotly-free" class="js-splash--navigation-item">Is Plotly Free?</a>
123-
</li>
124-
{% endif %}
125109

126-
<!-- Cheat Sheets -->
127-
{% if page.language == "plotly_js" or page.language == "r" or page.language == "matlab" %}
110+
{% if page.language == "r" or page.language == "python" or page.language == "plotly_js"%}
128111
<li class="--sidebar-item">
129-
<a href="https://images.plot.ly/plotly-documentation/images/{{ page.language }}_cheat_sheet.pdf" class="js-splash--navigation-item">Cheat Sheet</a>
112+
<a href="/{{ langue }}/is-plotly-free" class="js-splash--navigation-item">Is Plotly Free?</a>
130113
</li>
131114
{% endif %}
132115

133116
<!-- Reference Pages -->
134-
{% if page.language == "r" or page.language == "python" or page.language == "matlab" %}
117+
{% if page.language == "plotly_js" or page.language == "r" or page.language == "python" or page.language == "matlab" or page.language == "julia" %}
135118
<li class="--sidebar-item">
136-
<a href="/{{ page.language }}/reference/index/" class="js-splash--navigation-item">Figure Reference</a>
119+
<a href="/{{ langue }}/reference/index/" class="js-splash--navigation-item">Figure Reference</a>
137120
</li>
138121
{% endif %}
122+
123+
<!-- Python Specific -->
124+
139125
{% if page.language == "python" %}
140126
<li class="--sidebar-item">
141127
<a href="/python-api-reference" class="js-splash--navigation-item">API Reference</a>
142128
</li>
143-
{% endif %}
144-
145-
<!-- User Guides -->
146-
{% if page.language == "matlab" or page.language == "scala" %}
147129
<li class="--sidebar-item">
148-
<a href="/{{ page.language }}/user-guide/" class="js-splash--navigation-item">User Guide</a>
149-
</li>
150-
{% endif %}
151-
152-
{% if page.language == "matlab" %}
153-
<li class="--sidebar-item">
154-
<a href="/{{ page.language }}/offline/" class="js-splash--navigation-item">Use Offline</a>
130+
<a href="https://plotly.com/dash" class="js-splash--navigation-item">Dash</a>
155131
</li>
156132
{% endif %}
157133

158134
<!-- JS Specific -->
159135
{% if page.language == "plotly_js" %}
160-
<li class="--sidebar-item">
161-
<a href="/javascript/reference/index/" class="js-splash--navigation-item">Figure Reference</a>
162-
</li>
163136
<li class="--sidebar-item">
164137
<a href="/javascript/plotlyjs-function-reference/" class="js-splash--navigation-item">Function Reference</a>
165138
</li>
@@ -181,33 +154,51 @@
181154
</li>
182155
{% endif %}
183156

184-
<!-- Python Specific -->
185-
{% if page.language == "python" %}
157+
<!-- Python/v3 Index Page Specific -->
158+
{% if page.permalink == "/python/v3/" %}
186159
<li class="--sidebar-item">
187-
<a href="https://plotly.com/dash" class="js-splash--navigation-item">Dash</a>
160+
<a href="/ipython-notebooks/" class="js-splash--navigation-item">IPython Notebooks</a>
188161
</li>
189162
{% endif %}
190163

191-
<!-- Python/v3 Index Page Specific -->
192-
{% if page.permalink == "/python/v3/" %}
164+
<!-- MATLAB Specific -->
165+
{% if page.language == "matlab" %}
193166
<li class="--sidebar-item">
194-
<a href="/ipython-notebooks/" class="js-splash--navigation-item">IPython Notebooks</a>
167+
<a href="/{{ page.language }}/offline/" class="js-splash--navigation-item">Use Offline</a>
168+
</li>
169+
{% endif %}
170+
171+
172+
<!-- User Guides -->
173+
{% if page.language == "matlab" or page.language == "scala" %}
174+
<li class="--sidebar-item">
175+
<a href="/{{ page.language }}/user-guide/" class="js-splash--navigation-item">User Guide</a>
195176
</li>
196177
{% endif %}
197178

179+
<!-- Cheat Sheets -->
180+
{% if page.language == "plotly_js" or page.language == "r" or page.language == "matlab" %}
181+
<li class="--sidebar-item">
182+
<a href="https://images.plot.ly/plotly-documentation/images/{{ page.language }}_cheat_sheet.pdf" class="js-splash--navigation-item">Cheat Sheet</a>
183+
</li>
184+
{% endif %}
185+
186+
187+
<!-- Github Links -->
188+
198189
{% if page.language == 'python' %}
199190
<li class="--sidebar-item">
200191
<a target="_blank" href="https://github.com/plotly/plotly.py" class="js-splash--navigation-item">GitHub</a>
201192
</li>
202193

203194
{% elsif page.language == 'matlab' %}
204195
<li class="--sidebar-item">
205-
<a target="_blank" href="https://github.com/plotly/matlab-api" class="js-splash--navigation-item">GitHub</a>
196+
<a target="_blank" href="https://github.com/plotly/plotly-graphing-library-for-matlab" class="js-splash--navigation-item">GitHub</a>
206197
</li>
207198

208199
{% elsif page.language == 'julia' %}
209200
<li class="--sidebar-item">
210-
<a target="_blank" href="https://github.com/plotly/Julia-API" class="js-splash--navigation-item">GitHub</a>
201+
<a target="_blank" href="https://github.com/JuliaPlots/PlotlyJS.jl" class="js-splash--navigation-item">GitHub</a>
211202
</li>
212203

213204
{% elsif page.language == 'nodejs' %}

‎_posts/reference_pages/2020-07-20-julia-ref_index.html‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
permalink: /julia/reference/index/
3+
layout: langindex
4+
page_type: reference
5+
language: julia
6+
name: Reference Index
7+
description: Figure attribute reference for Plotly's julia open-source graphing library.
8+
---
9+
<h2>julia Figure Reference</h2>
10+
11+
<br />
12+
<p>The pages linked in the sidebar together form the exhaustive reference for all of the attributes in the core figure data structure
13+
that the <code>PlotlyJS.jl</code> library operates on. They are automatically-generated from the
14+
<a href="https://raw.githubusercontent.com/plotly/plotly.js/master/dist/plot-schema.json">machine-readable Plotly.js schema reference</a>.</p>
15+
16+
17+
<p>&nbsp;</p>
18+
19+
<p>&nbsp;</p>
20+
21+
<p>&nbsp;</p>
22+
23+
<p>&nbsp;</p>
24+
25+
<p>&nbsp;</p>
26+
27+
<p>&nbsp;</p>
28+
29+
<p>&nbsp;</p>
30+
31+
<p>&nbsp;</p>
32+
33+
<p>&nbsp;</p>
34+
35+
<p>&nbsp;</p>
36+
37+
<p>&nbsp;</p>
38+
39+
<p>&nbsp;</p>
40+
41+
<p>&nbsp;</p>
42+
43+
<p>&nbsp;</p>
44+
<p>&nbsp;</p>
45+
46+
<p>&nbsp;</p>
47+
48+
<p>&nbsp;</p>
49+
50+
<p>&nbsp;</p>
51+
52+
<p>&nbsp;</p>
53+
54+
<p>&nbsp;</p>
55+
56+
<p>&nbsp;</p>
57+
58+
<p>&nbsp;</p>

‎_posts/reference_pages/2020-07-20-julia-reference.html‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
permalink: /julia/reference/
3+
layout: langindex
4+
page_type: reference
5+
language: julia
6+
name: Single-Page Reference
7+
description: Figure attribute reference for Plotly's Julia open-source graphing library.
8+
---
9+
<h2>Julia Figure Reference: Single Page</h2>
10+
11+
12+
13+
14+
{% include posts/plotschema-reference.html %}

‎_posts/reference_pages/julia/2020-07-20-annotations.html‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
permalink: /julia/reference/layout/annotations/
3+
layout: langindex
4+
page_type: reference
5+
language: julia
6+
name: layout.annotations
7+
description: Figure attribute reference for Plotly's Julia open-source graphing library.
8+
---
9+
10+
<h2>Julia Figure Reference: <code>layout.annotations</code></h2>
11+
12+
<div class="row">
13+
<div class="eight columns" style="max-width: 900px;">
14+
15+
{% assign attribute=site.data.plotschema.layout.layoutAttributes %}
16+
{% include posts/reference-block.html parentlink="layout" block="layout" parentpath="layout" mustmatch="annotations" %}
17+
18+
</div>
19+
</div>

‎_posts/reference_pages/julia/2020-07-20-bar.html‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
permalink: /julia/reference/bar/
3+
layout: langindex
4+
page_type: reference
5+
language: julia
6+
name: bar Traces
7+
description: Figure attribute reference for Plotly's Julia open-source graphing library.
8+
---
9+
10+
<h2>Julia Figure Reference: <code>bar</code> Traces</h2>
11+
12+
<div class="row">
13+
<div class="eight columns" style="max-width: 900px;">
14+
15+
{% include posts/reference-trace.html trace_name="bar" trace_data=site.data.plotschema.traces.bar %}
16+
17+
</div>
18+
</div>

‎_posts/reference_pages/julia/2020-07-20-barpolar.html‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
permalink: /julia/reference/barpolar/
3+
layout: langindex
4+
page_type: reference
5+
language: julia
6+
name: barpolar Traces
7+
description: Figure attribute reference for Plotly's Julia open-source graphing library.
8+
---
9+
10+
<h2>Julia Figure Reference: <code>barpolar</code> Traces</h2>
11+
12+
<div class="row">
13+
<div class="eight columns" style="max-width: 900px;">
14+
15+
{% include posts/reference-trace.html trace_name="barpolar" trace_data=site.data.plotschema.traces.barpolar %}
16+
17+
</div>
18+
</div>

‎_posts/reference_pages/julia/2020-07-20-box.html‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
permalink: /julia/reference/box/
3+
layout: langindex
4+
page_type: reference
5+
language: julia
6+
name: box Traces
7+
description: Figure attribute reference for Plotly's Julia open-source graphing library.
8+
---
9+
10+
<h2>Julia Figure Reference: <code>box</code> Traces</h2>
11+
12+
<div class="row">
13+
<div class="eight columns" style="max-width: 900px;">
14+
15+
{% include posts/reference-trace.html trace_name="box" trace_data=site.data.plotschema.traces.box %}
16+
17+
</div>
18+
</div>

‎_posts/reference_pages/julia/2020-07-20-candlestick.html‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
permalink: /julia/reference/candlestick/
3+
layout: langindex
4+
page_type: reference
5+
language: julia
6+
name: candlestick Traces
7+
description: Figure attribute reference for Plotly's Julia open-source graphing library.
8+
---
9+
10+
<h2>Julia Figure Reference: <code>candlestick</code> Traces</h2>
11+
12+
<div class="row">
13+
<div class="eight columns" style="max-width: 900px;">
14+
15+
{% include posts/reference-trace.html trace_name="candlestick" trace_data=site.data.plotschema.traces.candlestick %}
16+
17+
</div>
18+
</div>

‎_posts/reference_pages/julia/2020-07-20-carpet.html‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
permalink: /julia/reference/carpet/
3+
layout: langindex
4+
page_type: reference
5+
language: julia
6+
name: carpet Traces
7+
description: Figure attribute reference for Plotly's Julia open-source graphing library.
8+
---
9+
10+
<h2>Julia Figure Reference: <code>carpet</code> Traces</h2>
11+
12+
<div class="row">
13+
<div class="eight columns" style="max-width: 900px;">
14+
15+
{% include posts/reference-trace.html trace_name="carpet" trace_data=site.data.plotschema.traces.carpet %}
16+
17+
</div>
18+
</div>

0 commit comments

Comments
 (0)