Skip to content

Commit 843bcc3

Browse files
github-actions[bot]github-actions[bot]
committed
CI: Update docs for 0.3.1 (a49122c)
1 parent 1daebdb commit 843bcc3

File tree

9 files changed

+115
-114
lines changed

9 files changed

+115
-114
lines changed

‎doc/backtesting/backtesting.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
6-
<meta name="generator" content="pdoc 0.9.1" />
6+
<meta name="generator" content="pdoc 0.9.2" />
77
<title>backtesting.backtesting API documentation</title>
88
<meta name="description" content="Core framework data structures.
99
Objects from this module can also be imported from the top-level
@@ -457,7 +457,7 @@ <h3>Methods</h3>
457457
</code></pre></div>
458458
</dd>
459459
<dt id="backtesting.backtesting.Strategy.buy"><code class="name flex">
460-
<span>def <span class="ident">buy</span></span>(<span>self, *, size=0.9999999999999998, limit=None, stop=None, sl=None, tp=None)</span>
460+
<span>def <span class="ident">buy</span></span>(<span>self, *, size=.9999, limit=None, stop=None, sl=None, tp=None)</span>
461461
</code></dt>
462462
<dd>
463463
<div class="desc"><p>Place a new long order. For explanation of parameters, see <code><a title="backtesting.backtesting.Order" href="#backtesting.backtesting.Order">Order</a></code> and its properties.</p>
@@ -493,7 +493,7 @@ <h3>Methods</h3>
493493
</code></pre></div>
494494
</dd>
495495
<dt id="backtesting.backtesting.Strategy.sell"><code class="name flex">
496-
<span>def <span class="ident">sell</span></span>(<span>self, *, size=0.9999999999999998, limit=None, stop=None, sl=None, tp=None)</span>
496+
<span>def <span class="ident">sell</span></span>(<span>self, *, size=.9999, limit=None, stop=None, sl=None, tp=None)</span>
497497
</code></dt>
498498
<dd>
499499
<div class="desc"><p>Place a new short order. For explanation of parameters, see <code><a title="backtesting.backtesting.Order" href="#backtesting.backtesting.Order">Order</a></code> and its properties.</p>
@@ -684,12 +684,12 @@ <h4><code><a title="backtesting.backtesting.Trade" href="#backtesting.backtestin
684684
</main>
685685
<footer id="footer">
686686
<p>
687-
<a href="https://kernc.github.io/backtesting.py/"><cite>backtesting</cite> 0.3.0</a>
687+
<a href="https://kernc.github.io/backtesting.py/"><cite>backtesting</cite> 0.3.1</a>
688688
<span style="color:#ddd">&#21328;</span>
689689
</p>
690690
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
691691
<script>hljs.configure({languages: ['python']}); hljs.initHighlightingOnLoad()</script>
692-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
692+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
693693
</footer>
694694
<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;ga('create','UA-43663477-4','auto');ga('require','cleanUrlTracker',{indexFilename:'index.html',trailingSlash:'add'});ga('require','outboundLinkTracker',{events:['click','auxclick','contextmenu']});ga('require', 'maxScrollTracker');ga('require', 'pageVisibilityTracker');ga('send', 'pageview');setTimeout(function(){ga('send','event','pageview','view')},15000);</script><script async src='https://www.google-analytics.com/analytics.js'></script><script async src='https://cdnjs.cloudflare.com/ajax/libs/autotrack/2.4.1/autotrack.js'></script></body>
695695
</html>

‎doc/backtesting/index.html‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
6-
<meta name="generator" content="pdoc 0.9.1" />
6+
<meta name="generator" content="pdoc 0.9.2" />
77
<title>backtesting API documentation</title>
88
<meta name="description" content="Manuals …" />
99
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -57,8 +57,10 @@ <h2 id="example-strategies">Example Strategies</h2>
5757
<a href="https://github.com/kernc/backtesting.py/blob/master/CHANGELOG.md">What's New</a>.</p>
5858
</div>
5959
<h2 id="faq">FAQ</h2>
60-
<p>Potentially outdated answers to frequent and popular questions can be found on the
61-
<a href="https://github.com/kernc/backtesting.py/issues?q=label%3Aquestion+-label%3Ainvalid">issue tracker</a>.</p>
60+
<p>Some answers to frequent and popular questions can be found on the
61+
<a href="https://github.com/kernc/backtesting.py/issues?q=label%3Aquestion+-label%3Ainvalid">issue tracker</a>
62+
or on the <a href="https://github.com/kernc/backtesting.py/discussions">discussion forum</a> on GitHub.
63+
Please use the search!</p>
6264
<h2 id="license">License</h2>
6365
<p>This software is licensed under the terms of <a href="https://www.gnu.org/licenses/agpl-3.0.html" rel="license">AGPL 3.0</a>,
6466
meaning you can use it for any reasonable purpose and remain in
@@ -128,12 +130,12 @@ <h1>Index</h1>
128130
</main>
129131
<footer id="footer">
130132
<p>
131-
<a href="https://kernc.github.io/backtesting.py/"><cite>backtesting</cite> 0.3.0</a>
133+
<a href="https://kernc.github.io/backtesting.py/"><cite>backtesting</cite> 0.3.1</a>
132134
<span style="color:#ddd">&#21328;</span>
133135
</p>
134136
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
135137
<script>hljs.configure({languages: ['python']}); hljs.initHighlightingOnLoad()</script>
136-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
138+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
137139
</footer>
138140
<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;ga('create','UA-43663477-4','auto');ga('require','cleanUrlTracker',{indexFilename:'index.html',trailingSlash:'add'});ga('require','outboundLinkTracker',{events:['click','auxclick','contextmenu']});ga('require', 'maxScrollTracker');ga('require', 'pageVisibilityTracker');ga('send', 'pageview');setTimeout(function(){ga('send','event','pageview','view')},15000);</script><script async src='https://www.google-analytics.com/analytics.js'></script><script async src='https://cdnjs.cloudflare.com/ajax/libs/autotrack/2.4.1/autotrack.js'></script></body>
139141
</html>

‎doc/backtesting/lib.html‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
6-
<meta name="generator" content="pdoc 0.9.1" />
6+
<meta name="generator" content="pdoc 0.9.2" />
77
<title>backtesting.lib API documentation</title>
88
<meta name="description" content="Collection of common building blocks, helper auxiliary functions and
99
composable strategy classes for reuse …" />
@@ -275,7 +275,6 @@ <h3>Inherited members</h3>
275275
</dd>
276276
<dt id="backtesting.lib.TrailingStrategy"><code class="flex name class">
277277
<span>class <span class="ident">TrailingStrategy</span></span>
278-
<span>(</span><span>broker, data, params)</span>
279278
</code></dt>
280279
<dd>
281280
<div class="desc"><p>A strategy with automatic trailing stop-loss, trailing the current
@@ -386,12 +385,12 @@ <h4><code><a title="backtesting.lib.TrailingStrategy" href="#backtesting.lib.Tra
386385
</main>
387386
<footer id="footer">
388387
<p>
389-
<a href="https://kernc.github.io/backtesting.py/"><cite>backtesting</cite> 0.3.0</a>
388+
<a href="https://kernc.github.io/backtesting.py/"><cite>backtesting</cite> 0.3.1</a>
390389
<span style="color:#ddd">&#21328;</span>
391390
</p>
392391
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
393392
<script>hljs.configure({languages: ['python']}); hljs.initHighlightingOnLoad()</script>
394-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
393+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
395394
</footer>
396395
<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;ga('create','UA-43663477-4','auto');ga('require','cleanUrlTracker',{indexFilename:'index.html',trailingSlash:'add'});ga('require','outboundLinkTracker',{events:['click','auxclick','contextmenu']});ga('require', 'maxScrollTracker');ga('require', 'pageVisibilityTracker');ga('send', 'pageview');setTimeout(function(){ga('send','event','pageview','view')},15000);</script><script async src='https://www.google-analytics.com/analytics.js'></script><script async src='https://cdnjs.cloudflare.com/ajax/libs/autotrack/2.4.1/autotrack.js'></script></body>
397396
</html>

‎doc/backtesting/test/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
6-
<meta name="generator" content="pdoc 0.9.1" />
6+
<meta name="generator" content="pdoc 0.9.2" />
77
<title>backtesting.test API documentation</title>
88
<meta name="description" content="Data and utilities for testing." />
99
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
@@ -99,12 +99,12 @@ <h1>Index</h1>
9999
</main>
100100
<footer id="footer">
101101
<p>
102-
<a href="https://kernc.github.io/backtesting.py/"><cite>backtesting</cite> 0.3.0</a>
102+
<a href="https://kernc.github.io/backtesting.py/"><cite>backtesting</cite> 0.3.1</a>
103103
<span style="color:#ddd">&#21328;</span>
104104
</p>
105105
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
106106
<script>hljs.configure({languages: ['python']}); hljs.initHighlightingOnLoad()</script>
107-
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.1</a>.</p>
107+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
108108
</footer>
109109
<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;ga('create','UA-43663477-4','auto');ga('require','cleanUrlTracker',{indexFilename:'index.html',trailingSlash:'add'});ga('require','outboundLinkTracker',{events:['click','auxclick','contextmenu']});ga('require', 'maxScrollTracker');ga('require', 'pageVisibilityTracker');ga('send', 'pageview');setTimeout(function(){ga('send','event','pageview','view')},15000);</script><script async src='https://www.google-analytics.com/analytics.js'></script><script async src='https://cdnjs.cloudflare.com/ajax/libs/autotrack/2.4.1/autotrack.js'></script></body>
110110
</html>

‎doc/examples/Multiple Time Frames.html‎

Lines changed: 15 additions & 15 deletions
Large diffs are not rendered by default.

‎doc/examples/Parameter Heatmap & Optimization.html‎

Lines changed: 34 additions & 34 deletions
Large diffs are not rendered by default.

‎doc/examples/Quick Start User Guide.html‎

Lines changed: 18 additions & 18 deletions
Large diffs are not rendered by default.

‎doc/examples/Strategies Library.html‎

Lines changed: 8 additions & 8 deletions
Large diffs are not rendered by default.

‎doc/examples/Trading with Machine Learning.html‎

Lines changed: 22 additions & 22 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)