build based on b41a95b

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2025-01-01T19:35:38","documenter_version":"1.8.0"}}
+{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2025-01-08T19:37:11","documenter_version":"1.8.0"}}

dev/index.html

@@ -70,4 +70,4 @@
     update!(golden_cross_chart, c)
 end
 
-lwc_save(&quot;golden_cross_example.html&quot;, visualize(golden_cross_chart));</code></pre><iframe src="./golden_cross_example.html" style="height:777px;width:100%;"></iframe><div class="admonition is-success"><header class="admonition-header">Tip</header><div class="admonition-body"><ul><li>Zoom in and out with the gestures you&#39;re accustomed to.</li><li>Click and drag the chart to scroll around.</li><li>Clicking and dragging the price scale on the left will give you a fixed scale and disable the default autoscaling.<ul><li>Double click the price scale to re-enable autoscaling of price.</li></ul></li><li>Click on items in the legend on the top-left to toggle their visibility.</li></ul></div></div><h3 id="Notebooks"><a class="docs-heading-anchor" href="#Notebooks">Notebooks</a><a id="Notebooks-1"></a><a class="docs-heading-anchor-permalink" href="#Notebooks" title="Permalink"></a></h3><p>If you were in a Pluto.jl or Jupyter notebook, use <code>visualize</code> to make the chart renderable.</p><pre><code class="language-julia hljs">visualize(golden_cross_chart)</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="indicators/">Indicators »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Wednesday 1 January 2025 19:35">Wednesday 1 January 2025</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+lwc_save(&quot;golden_cross_example.html&quot;, visualize(golden_cross_chart));</code></pre><iframe src="./golden_cross_example.html" style="height:777px;width:100%;"></iframe><div class="admonition is-success"><header class="admonition-header">Tip</header><div class="admonition-body"><ul><li>Zoom in and out with the gestures you&#39;re accustomed to.</li><li>Click and drag the chart to scroll around.</li><li>Clicking and dragging the price scale on the left will give you a fixed scale and disable the default autoscaling.<ul><li>Double click the price scale to re-enable autoscaling of price.</li></ul></li><li>Click on items in the legend on the top-left to toggle their visibility.</li></ul></div></div><h3 id="Notebooks"><a class="docs-heading-anchor" href="#Notebooks">Notebooks</a><a id="Notebooks-1"></a><a class="docs-heading-anchor-permalink" href="#Notebooks" title="Permalink"></a></h3><p>If you were in a Pluto.jl or Jupyter notebook, use <code>visualize</code> to make the chart renderable.</p><pre><code class="language-julia hljs">visualize(golden_cross_chart)</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="indicators/">Indicators »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Wednesday 8 January 2025 19:37">Wednesday 8 January 2025</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/indicators/index.html

@@ -20,4 +20,4 @@
         [df[!, name][start:end]...];
         kwargs...
     )
-end</code></pre><p>If you need to return more than one line, return them in a vector. A good example of this is <a href="https://github.com/g-gundam/TechnicalIndicatorCharts.jl/blob/main/src/BB.jl">BB.jl</a> which returns 3 lwc_lines.</p><p>You&#39;re also not limited to <code>lwc_line</code>.  You can use any visualization function supported by <a href="https://bhftbootcamp.github.io/LightweightCharts.jl/dev/pages/charts/">LightweightCharts.jl</a>.</p><h3 id="Examples"><a class="docs-heading-anchor" href="#Examples">Examples</a><a id="Examples-1"></a><a class="docs-heading-anchor-permalink" href="#Examples" title="Permalink"></a></h3><p>All indicator visualizations fall into one of these four categories.</p><table><tr><th style="text-align: right"></th><th style="text-align: right">Denominated in Price</th><th style="text-align: right">Not Denominated in Price</th></tr><tr><td style="text-align: right">Single Visual Element</td><td style="text-align: right">EMA, HMA, SMA</td><td style="text-align: right">RSI</td></tr><tr><td style="text-align: right">Multiple Visual Elements</td><td style="text-align: right">BB</td><td style="text-align: right">StochRSI</td></tr></table><p>When implementing a new visualization, feel free to look at the <a href="https://github.com/g-gundam/TechnicalIndicatorCharts.jl/tree/main/src">source</a> for these and use them as a starting point for your own work.</p><h2 id="Finally"><a class="docs-heading-anchor" href="#Finally">Finally</a><a id="Finally-1"></a><a class="docs-heading-anchor-permalink" href="#Finally" title="Permalink"></a></h2><ul><li>Add an <code>include</code> for your newly implemented indicator at the bottom of <a href="https://github.com/g-gundam/TechnicalIndicatorCharts.jl/blob/main/src/TechnicalIndicatorCharts.jl">src/TechnicalIndicatorCharts.jl</a>.</li><li>Add a test for your indicator.  A basic test that makes sure it doesn&#39;t crash when visualize is run is enough.</li><li>Mark that the indicator is done in the <a href="https://github.com/g-gundam/TechnicalIndicatorCharts.jl/blob/main/README.md?plain=1">README.md</a> for this project.</li></ul><h2 id="Thanks"><a class="docs-heading-anchor" href="#Thanks">Thanks</a><a id="Thanks-1"></a><a class="docs-heading-anchor-permalink" href="#Thanks" title="Permalink"></a></h2><p>Thanks to all future indicator visualization authors.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../api/">API »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Wednesday 1 January 2025 19:35">Wednesday 1 January 2025</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre><p>If you need to return more than one line, return them in a vector. A good example of this is <a href="https://github.com/g-gundam/TechnicalIndicatorCharts.jl/blob/main/src/BB.jl">BB.jl</a> which returns 3 lwc_lines.</p><p>You&#39;re also not limited to <code>lwc_line</code>.  You can use any visualization function supported by <a href="https://bhftbootcamp.github.io/LightweightCharts.jl/dev/pages/charts/">LightweightCharts.jl</a>.</p><h3 id="Examples"><a class="docs-heading-anchor" href="#Examples">Examples</a><a id="Examples-1"></a><a class="docs-heading-anchor-permalink" href="#Examples" title="Permalink"></a></h3><p>All indicator visualizations fall into one of these four categories.</p><table><tr><th style="text-align: right"></th><th style="text-align: right">Denominated in Price</th><th style="text-align: right">Not Denominated in Price</th></tr><tr><td style="text-align: right">Single Visual Element</td><td style="text-align: right">EMA, HMA, SMA</td><td style="text-align: right">RSI</td></tr><tr><td style="text-align: right">Multiple Visual Elements</td><td style="text-align: right">BB</td><td style="text-align: right">StochRSI</td></tr></table><p>When implementing a new visualization, feel free to look at the <a href="https://github.com/g-gundam/TechnicalIndicatorCharts.jl/tree/main/src">source</a> for these and use them as a starting point for your own work.</p><h2 id="Finally"><a class="docs-heading-anchor" href="#Finally">Finally</a><a id="Finally-1"></a><a class="docs-heading-anchor-permalink" href="#Finally" title="Permalink"></a></h2><ul><li>Add an <code>include</code> for your newly implemented indicator at the bottom of <a href="https://github.com/g-gundam/TechnicalIndicatorCharts.jl/blob/main/src/TechnicalIndicatorCharts.jl">src/TechnicalIndicatorCharts.jl</a>.</li><li>Add a test for your indicator.  A basic test that makes sure it doesn&#39;t crash when visualize is run is enough.</li><li>Mark that the indicator is done in the <a href="https://github.com/g-gundam/TechnicalIndicatorCharts.jl/blob/main/README.md?plain=1">README.md</a> for this project.</li></ul><h2 id="Thanks"><a class="docs-heading-anchor" href="#Thanks">Thanks</a><a id="Thanks-1"></a><a class="docs-heading-anchor-permalink" href="#Thanks" title="Permalink"></a></h2><p>Thanks to all future indicator visualization authors.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../api/">API »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Wednesday 8 January 2025 19:37">Wednesday 8 January 2025</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>