Skip to content

Commit a960ec9

Browse files
oliver-zehentleitneroliver-zehentleitner
committed
docs example result
1 parent 421f5fc commit a960ec9

File tree

15 files changed

+16
-35
lines changed

15 files changed

+16
-35
lines changed

‎README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,8 @@ inspection.
7777
```
7878
from backtesting import Backtest, Strategy
7979
from backtesting.lib import crossover
80-
8180
from backtesting.test import SMA, GOOG
8281
83-
8482
class SmaCross(Strategy):
8583
def init(self):
8684
price = self.data.Close
@@ -93,9 +91,7 @@ class SmaCross(Strategy):
9391
elif crossover(self.ma2, self.ma1):
9492
self.sell()
9593
96-
97-
bt = Backtest(GOOG, SmaCross, commission=.02,
98-
exclusive_orders=True)
94+
bt = Backtest(GOOG, SmaCross, commission=.002, exclusive_orders=True)
9995
stats = bt.run()
10096
bt.plot()
10197
```
@@ -104,7 +100,6 @@ Results in:
104100

105101
[![Backtesting HTML result](https://raw.githubusercontent.com/LUCIT-Systems-and-Development/lucit-backtesting/master/images/example_html_result.png)](https://lucit-backtesting.docs.lucit.tech/_static/example_result.html)
106102

107-
108103
```
109104
Start 2004-08-19 00:00:00
110105
End 2013-03-01 00:00:00

‎dev/sphinx/source/readme.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,8 @@ inspection.
7777
```
7878
from backtesting import Backtest, Strategy
7979
from backtesting.lib import crossover
80-
8180
from backtesting.test import SMA, GOOG
8281
83-
8482
class SmaCross(Strategy):
8583
def init(self):
8684
price = self.data.Close
@@ -93,9 +91,7 @@ class SmaCross(Strategy):
9391
elif crossover(self.ma2, self.ma1):
9492
self.sell()
9593
96-
97-
bt = Backtest(GOOG, SmaCross, commission=.02,
98-
exclusive_orders=True)
94+
bt = Backtest(GOOG, SmaCross, commission=.002, exclusive_orders=True)
9995
stats = bt.run()
10096
bt.plot()
10197
```
@@ -104,7 +100,6 @@ Results in:
104100

105101
[![Backtesting HTML result](https://raw.githubusercontent.com/LUCIT-Systems-and-Development/lucit-backtesting/master/images/example_html_result.png)](https://lucit-backtesting.docs.lucit.tech/_static/example_result.html)
106102

107-
108103
```
109104
Start 2004-08-19 00:00:00
110105
End 2013-03-01 00:00:00

‎docs/_modules/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ <h3>Navigation</h3>
249249
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
250250
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
251251
See <a href="/license.html">License</a> for more information.<br />
252-
Last updated on Jun 07 2024 at 10:37 (CET).
252+
Last updated on Jun 07 2024 at 10:42 (CET).
253253
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
254254
<br />
255255
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/_sources/readme.md.txt

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,8 @@ inspection.
7777
```
7878
from backtesting import Backtest, Strategy
7979
from backtesting.lib import crossover
80-
8180
from backtesting.test import SMA, GOOG
8281

83-
8482
class SmaCross(Strategy):
8583
def init(self):
8684
price = self.data.Close
@@ -93,9 +91,7 @@ class SmaCross(Strategy):
9391
elif crossover(self.ma2, self.ma1):
9492
self.sell()
9593

96-
97-
bt = Backtest(GOOG, SmaCross, commission=.02,
98-
exclusive_orders=True)
94+
bt = Backtest(GOOG, SmaCross, commission=.002, exclusive_orders=True)
9995
stats = bt.run()
10096
bt.plot()
10197
```
@@ -104,7 +100,6 @@ Results in:
104100

105101
[![Backtesting HTML result](https://raw.githubusercontent.com/LUCIT-Systems-and-Development/lucit-backtesting/master/images/example_html_result.png)](https://lucit-backtesting.docs.lucit.tech/_static/example_result.html)
106102

107-
108103
```
109104
Start 2004-08-19 00:00:00
110105
End 2013-03-01 00:00:00

‎docs/changelog.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -510,7 +510,7 @@ <h3>Navigation</h3>
510510
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
511511
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
512512
See <a href="/license.html">License</a> for more information.<br />
513-
Last updated on Jun 07 2024 at 10:37 (CET).
513+
Last updated on Jun 07 2024 at 10:42 (CET).
514514
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
515515
<br />
516516
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/code_of_conduct.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@ <h3>Navigation</h3>
399399
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
400400
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
401401
See <a href="/license.html">License</a> for more information.<br />
402-
Last updated on Jun 07 2024 at 10:37 (CET).
402+
Last updated on Jun 07 2024 at 10:42 (CET).
403403
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
404404
<br />
405405
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/contributing.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ <h3>Navigation</h3>
377377
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
378378
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
379379
See <a href="/license.html">License</a> for more information.<br />
380-
Last updated on Jun 07 2024 at 10:37 (CET).
380+
Last updated on Jun 07 2024 at 10:42 (CET).
381381
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
382382
<br />
383383
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/genindex.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -569,7 +569,7 @@ <h3>Navigation</h3>
569569
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
570570
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
571571
See <a href="/license.html">License</a> for more information.<br />
572-
Last updated on Jun 07 2024 at 10:37 (CET).
572+
Last updated on Jun 07 2024 at 10:42 (CET).
573573
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
574574
<br />
575575
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -417,7 +417,7 @@ <h3>Navigation</h3>
417417
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
418418
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
419419
See <a href="/license.html">License</a> for more information.<br />
420-
Last updated on Jun 07 2024 at 10:37 (CET).
420+
Last updated on Jun 07 2024 at 10:42 (CET).
421421
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
422422
<br />
423423
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/license.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -967,7 +967,7 @@ <h3>Navigation</h3>
967967
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
968968
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
969969
See <a href="/license.html">License</a> for more information.<br />
970-
Last updated on Jun 07 2024 at 10:37 (CET).
970+
Last updated on Jun 07 2024 at 10:42 (CET).
971971
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
972972
<br />
973973
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/py-modindex.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ <h3>Navigation</h3>
277277
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
278278
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
279279
See <a href="/license.html">License</a> for more information.<br />
280-
Last updated on Jun 07 2024 at 10:37 (CET).
280+
Last updated on Jun 07 2024 at 10:42 (CET).
281281
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
282282
<br />
283283
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/readme.html

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -283,10 +283,8 @@ <h2>Usage<a class="headerlink" href="#usage" title="Link to this heading">¶</a>
283283
inspection.</p>
284284
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">backtesting</span> <span class="kn">import</span> <span class="n">Backtest</span><span class="p">,</span> <span class="n">Strategy</span>
285285
<span class="kn">from</span> <span class="nn">backtesting.lib</span> <span class="kn">import</span> <span class="n">crossover</span>
286-
287286
<span class="kn">from</span> <span class="nn">backtesting.test</span> <span class="kn">import</span> <span class="n">SMA</span><span class="p">,</span> <span class="n">GOOG</span>
288287

289-
290288
<span class="k">class</span> <span class="nc">SmaCross</span><span class="p">(</span><span class="n">Strategy</span><span class="p">):</span>
291289
<span class="k">def</span> <span class="nf">init</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
292290
<span class="n">price</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">Close</span>
@@ -299,9 +297,7 @@ <h2>Usage<a class="headerlink" href="#usage" title="Link to this heading">¶</a>
299297
<span class="k">elif</span> <span class="n">crossover</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ma2</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">ma1</span><span class="p">):</span>
300298
<span class="bp">self</span><span class="o">.</span><span class="n">sell</span><span class="p">()</span>
301299

302-
303-
<span class="n">bt</span> <span class="o">=</span> <span class="n">Backtest</span><span class="p">(</span><span class="n">GOOG</span><span class="p">,</span> <span class="n">SmaCross</span><span class="p">,</span> <span class="n">commission</span><span class="o">=</span><span class="mf">.02</span><span class="p">,</span>
304-
<span class="n">exclusive_orders</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
300+
<span class="n">bt</span> <span class="o">=</span> <span class="n">Backtest</span><span class="p">(</span><span class="n">GOOG</span><span class="p">,</span> <span class="n">SmaCross</span><span class="p">,</span> <span class="n">commission</span><span class="o">=</span><span class="mf">.002</span><span class="p">,</span> <span class="n">exclusive_orders</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
305301
<span class="n">stats</span> <span class="o">=</span> <span class="n">bt</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>
306302
<span class="n">bt</span><span class="o">.</span><span class="n">plot</span><span class="p">()</span>
307303
</pre></div>
@@ -496,7 +492,7 @@ <h3>Navigation</h3>
496492
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
497493
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
498494
See <a href="/license.html">License</a> for more information.<br />
499-
Last updated on Jun 07 2024 at 10:37 (CET).
495+
Last updated on Jun 07 2024 at 10:42 (CET).
500496
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
501497
<br />
502498
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/search.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ <h3>Navigation</h3>
227227
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
228228
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
229229
See <a href="/license.html">License</a> for more information.<br />
230-
Last updated on Jun 07 2024 at 10:37 (CET).
230+
Last updated on Jun 07 2024 at 10:42 (CET).
231231
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
232232
<br />
233233
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/security.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ <h3>Navigation</h3>
344344
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
345345
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
346346
See <a href="/license.html">License</a> for more information.<br />
347-
Last updated on Jun 07 2024 at 10:37 (CET).
347+
Last updated on Jun 07 2024 at 10:42 (CET).
348348
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
349349
<br />
350350
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

0 commit comments

Comments
 (0)