Skip to content

Commit 7683a6d

Browse files
CI: Update docs for 0.3.3 (0107d4a)
1 parent 7abfa6a commit 7683a6d

File tree

9 files changed

+3368
-665
lines changed

9 files changed

+3368
-665
lines changed

β€Ždoc/backtesting/backtesting.htmlβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ <h3>Methods</h3>
134134
inspection, e.g. with <a href="https://scikit-optimize.github.io">scikit-optimize</a>
135135
<a href="https://scikit-optimize.github.io/stable/modules/plots.html">plotting tools</a>.</p>
136136
<p>If you want reproducible optimization results, set <code>random_state</code>
137-
to a fixed integer or a <code>numpy.random.RandomState</code> object.</p>
137+
to a fixed integer random seed.</p>
138138
<p>Additional keyword arguments represent strategy arguments with
139139
list-like collections of possible values. For example, the following
140140
code finds and returns the "best" of the 7 admissible (of the
@@ -684,7 +684,7 @@ <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.2</a>
687+
<a href="https://kernc.github.io/backtesting.py/"><cite>backtesting</cite> 0.3.3</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>

β€Ždoc/backtesting/index.htmlβ€Ž

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
66
<meta name="generator" content="pdoc 0.10.0" />
77
<title>backtesting API documentation</title>
8-
<meta name="description" content="Manuals …" />
8+
<meta name="description" content="![xkcd.com/1570](https://imgs.xkcd.com/comics/engineer_syllogism.png) …" />
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>
1010
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
1111
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
@@ -32,6 +32,7 @@
3232
<h1 class="title">Package <code>backtesting</code></h1>
3333
</header>
3434
<section id="section-intro">
35+
<p><img alt="xkcd.com/1570" src="https://imgs.xkcd.com/comics/engineer_syllogism.png"></p>
3536
<h2 id="manuals">Manuals</h2>
3637
<ul>
3738
<li><a href="../examples/Quick Start User Guide.html"><strong>Quick Start User Guide</strong></a></li>
@@ -130,7 +131,7 @@ <h1>Index</h1>
130131
</main>
131132
<footer id="footer">
132133
<p>
133-
<a href="https://kernc.github.io/backtesting.py/"><cite>backtesting</cite> 0.3.2</a>
134+
<a href="https://kernc.github.io/backtesting.py/"><cite>backtesting</cite> 0.3.3</a>
134135
<span style="color:#ddd">&#21328;</span>
135136
</p>
136137
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>

β€Ždoc/backtesting/lib.htmlβ€Ž

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ <h2 class="section-title" id="header-functions">Functions</h2>
9595
<span>def <span class="ident">cross</span></span>(<span>series1, series2)</span>
9696
</code></dt>
9797
<dd>
98-
<div class="desc"><p>Return <code>True</code> if <code>series1</code> and <code>series2</code> just crossed (either
99-
direction).</p>
98+
<div class="desc"><p>Return <code>True</code> if <code>series1</code> and <code>series2</code> just crossed
99+
(above or below) each other.</p>
100100
<pre><code>&gt;&gt;&gt; cross(self.data.Close, self.sma)
101101
True
102102
</code></pre></div>
@@ -105,7 +105,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
105105
<span>def <span class="ident">crossover</span></span>(<span>series1, series2)</span>
106106
</code></dt>
107107
<dd>
108-
<div class="desc"><p>Return <code>True</code> if <code>series1</code> just crossed over
108+
<div class="desc"><p>Return <code>True</code> if <code>series1</code> just crossed over (above)
109109
<code>series2</code>.</p>
110110
<pre><code>&gt;&gt;&gt; crossover(self.data.Close, self.sma)
111111
True
@@ -402,7 +402,7 @@ <h4><code><a title="backtesting.lib.TrailingStrategy" href="#backtesting.lib.Tra
402402
</main>
403403
<footer id="footer">
404404
<p>
405-
<a href="https://kernc.github.io/backtesting.py/"><cite>backtesting</cite> 0.3.2</a>
405+
<a href="https://kernc.github.io/backtesting.py/"><cite>backtesting</cite> 0.3.3</a>
406406
<span style="color:#ddd">&#21328;</span>
407407
</p>
408408
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>

β€Ždoc/backtesting/test/index.htmlβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <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.2</a>
102+
<a href="https://kernc.github.io/backtesting.py/"><cite>backtesting</cite> 0.3.3</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>

0 commit comments

Comments
Β (0)