Skip to content

Commit

Permalink
docs example result
Browse files Browse the repository at this point in the history
  • Loading branch information
@oliver-zehentleitner
oliver-zehentleitner committed Jun 7, 2024
1 parent 3d6eab7 commit dd4965d
Show file tree
Hide file tree
Showing 15 changed files with 20 additions and 16 deletions.
3 changes: 2 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,8 @@ we go long, buying as many stocks as we can afford. When it crosses below, we cl
We record most significant statistics this simple system produces on our data, and we show a plot for further manual
inspection.

```
```
#!/usr/bin/env python3
from backtesting import Backtest, Strategy
from backtesting.lib import crossover
from backtesting.test import SMA, GOOG
Expand Down
3 changes: 2 additions & 1 deletion dev/sphinx/source/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,8 @@ we go long, buying as many stocks as we can afford. When it crosses below, we cl
We record most significant statistics this simple system produces on our data, and we show a plot for further manual
inspection.

```
```
#!/usr/bin/env python3
from backtesting import Backtest, Strategy
from backtesting.lib import crossover
from backtesting.test import SMA, GOOG
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ <h3>Navigation</h3>
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Jun 07 2024 at 10:53 (CET).
Last updated on Jun 07 2024 at 12:11 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
3 changes: 2 additions & 1 deletion docs/_sources/readme.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,8 @@ we go long, buying as many stocks as we can afford. When it crosses below, we cl
We record most significant statistics this simple system produces on our data, and we show a plot for further manual
inspection.

```
```
#!/usr/bin/env python3
from backtesting import Backtest, Strategy
from backtesting.lib import crossover
from backtesting.test import SMA, GOOG
Expand Down
2 changes: 1 addition & 1 deletion docs/changelog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,7 @@ <h3>Navigation</h3>
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Jun 07 2024 at 10:53 (CET).
Last updated on Jun 07 2024 at 12:11 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/code_of_conduct.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -399,7 +399,7 @@ <h3>Navigation</h3>
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Jun 07 2024 at 10:53 (CET).
Last updated on Jun 07 2024 at 12:11 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ <h3>Navigation</h3>
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Jun 07 2024 at 10:53 (CET).
Last updated on Jun 07 2024 at 12:11 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,7 @@ <h3>Navigation</h3>
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Jun 07 2024 at 10:53 (CET).
Last updated on Jun 07 2024 at 12:11 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,7 @@ <h3>Navigation</h3>
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Jun 07 2024 at 10:53 (CET).
Last updated on Jun 07 2024 at 12:11 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/license.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -967,7 +967,7 @@ <h3>Navigation</h3>
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Jun 07 2024 at 10:53 (CET).
Last updated on Jun 07 2024 at 12:11 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/py-modindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ <h3>Navigation</h3>
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Jun 07 2024 at 10:53 (CET).
Last updated on Jun 07 2024 at 12:11 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
5 changes: 3 additions & 2 deletions docs/readme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,8 @@ <h2>Usage<a class="headerlink" href="#usage" title="Link to this heading">¶</a>
(assuming the underlying instrument is actually a CFD and can be shorted).</p>
<p>We record most significant statistics this simple system produces on our data, and we show a plot for further manual
inspection.</p>
<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>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/usr/bin/env python3</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>
<span class="kn">from</span> <span class="nn">backtesting.lib</span> <span class="kn">import</span> <span class="n">crossover</span>
<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>

Expand Down Expand Up @@ -525,7 +526,7 @@ <h3>Navigation</h3>
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Jun 07 2024 at 10:53 (CET).
Last updated on Jun 07 2024 at 12:11 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ <h3>Navigation</h3>
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Jun 07 2024 at 10:53 (CET).
Last updated on Jun 07 2024 at 12:11 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/security.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ <h3>Navigation</h3>
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Jun 07 2024 at 10:53 (CET).
Last updated on Jun 07 2024 at 12:11 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down

0 comments on commit dd4965d

Please sign in to comment.