Skip to content

Commit 42e6a85

Browse files
oliver-zehentleitneroliver-zehentleitner
committed
docs example result
1 parent bd177d8 commit 42e6a85

File tree

15 files changed

+20
-83
lines changed

15 files changed

+20
-83
lines changed

‎README.md

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -140,26 +140,11 @@ _trades Size EntryB...
140140
dtype: object
141141
```
142142

143-
## Features
144-
145-
* Simple, well-documented API
146-
* Blazing fast execution
147-
* Built-in optimizer
148-
* Library of composable base strategies and utilities
149-
* Indicator-library-agnostic
150-
* Supports _any_ financial instrument with candlestick data
151-
* Detailed results
152-
* Interactive visualizations
153-
154-
![xkcd.com/1570](https://imgs.xkcd.com/comics/engineer_syllogism.png)
155-
156-
157143
## Bugs
158144

159145
Before [reporting bugs](https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues) or posting to the
160-
[discussion board](https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/discussions),
161-
please read [contributing guidelines](https://lucit-backtesting.docs.lucit.tech/contributing.html),
162-
particularly the section about crafting useful bug reports and ```` ``` ````-fencing your code. We thank you!
146+
[discussion board](https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/discussions) and
147+
please read [contributing guidelines](https://lucit-backtesting.docs.lucit.tech/contributing.html). We thank you!
163148

164149
## Commercial Support
165150

‎dev/sphinx/source/readme.md

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -140,26 +140,11 @@ _trades Size EntryB...
140140
dtype: object
141141
```
142142

143-
## Features
144-
145-
* Simple, well-documented API
146-
* Blazing fast execution
147-
* Built-in optimizer
148-
* Library of composable base strategies and utilities
149-
* Indicator-library-agnostic
150-
* Supports _any_ financial instrument with candlestick data
151-
* Detailed results
152-
* Interactive visualizations
153-
154-
![xkcd.com/1570](https://imgs.xkcd.com/comics/engineer_syllogism.png)
155-
156-
157143
## Bugs
158144

159145
Before [reporting bugs](https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues) or posting to the
160-
[discussion board](https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/discussions),
161-
please read [contributing guidelines](https://lucit-backtesting.docs.lucit.tech/contributing.html),
162-
particularly the section about crafting useful bug reports and ```` ``` ````-fencing your code. We thank you!
146+
[discussion board](https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/discussions) and
147+
please read [contributing guidelines](https://lucit-backtesting.docs.lucit.tech/contributing.html). We thank you!
163148

164149
## Commercial Support
165150

‎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:22 (CET).
252+
Last updated on Jun 07 2024 at 10:27 (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: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -140,26 +140,11 @@ _trades Size EntryB...
140140
dtype: object
141141
```
142142

143-
## Features
144-
145-
* Simple, well-documented API
146-
* Blazing fast execution
147-
* Built-in optimizer
148-
* Library of composable base strategies and utilities
149-
* Indicator-library-agnostic
150-
* Supports _any_ financial instrument with candlestick data
151-
* Detailed results
152-
* Interactive visualizations
153-
154-
![xkcd.com/1570](https://imgs.xkcd.com/comics/engineer_syllogism.png)
155-
156-
157143
## Bugs
158144

159145
Before [reporting bugs](https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues) or posting to the
160-
[discussion board](https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/discussions),
161-
please read [contributing guidelines](https://lucit-backtesting.docs.lucit.tech/contributing.html),
162-
particularly the section about crafting useful bug reports and ```` ``` ````-fencing your code. We thank you!
146+
[discussion board](https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/discussions) and
147+
please read [contributing guidelines](https://lucit-backtesting.docs.lucit.tech/contributing.html). We thank you!
163148

164149
## Commercial Support
165150

‎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:22 (CET).
513+
Last updated on Jun 07 2024 at 10:27 (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:22 (CET).
402+
Last updated on Jun 07 2024 at 10:27 (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:22 (CET).
380+
Last updated on Jun 07 2024 at 10:27 (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:22 (CET).
572+
Last updated on Jun 07 2024 at 10:27 (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 & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,6 @@ <h1>Welcome to lucit-backtesting’s documentation!<a class="headerlink" href="#
176176
<li class="toctree-l2"><a class="reference internal" href="readme.html#description">Description</a></li>
177177
<li class="toctree-l2"><a class="reference internal" href="readme.html#installation">Installation</a></li>
178178
<li class="toctree-l2"><a class="reference internal" href="readme.html#usage">Usage</a></li>
179-
<li class="toctree-l2"><a class="reference internal" href="readme.html#features">Features</a></li>
180179
<li class="toctree-l2"><a class="reference internal" href="readme.html#bugs">Bugs</a></li>
181180
<li class="toctree-l2"><a class="reference internal" href="readme.html#commercial-support">Commercial Support</a></li>
182181
</ul>
@@ -418,7 +417,7 @@ <h3>Navigation</h3>
418417
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
419418
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
420419
See <a href="/license.html">License</a> for more information.<br />
421-
Last updated on Jun 07 2024 at 10:22 (CET).
420+
Last updated on Jun 07 2024 at 10:27 (CET).
422421
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
423422
<br />
424423
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:22 (CET).
970+
Last updated on Jun 07 2024 at 10:27 (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:22 (CET).
280+
Last updated on Jun 07 2024 at 10:27 (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: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,6 @@ <h3><a href="index.html">Table of Contents</a></h3>
6868
<li><a class="reference internal" href="#description">Description</a></li>
6969
<li><a class="reference internal" href="#installation">Installation</a></li>
7070
<li><a class="reference internal" href="#usage">Usage</a></li>
71-
<li><a class="reference internal" href="#features">Features</a></li>
7271
<li><a class="reference internal" href="#bugs">Bugs</a></li>
7372
<li><a class="reference internal" href="#commercial-support">Commercial Support</a></li>
7473
</ul>
@@ -344,26 +343,11 @@ <h2>Usage<a class="headerlink" href="#usage" title="Link to this heading">¶</a>
344343
</pre></div>
345344
</div>
346345
</section>
347-
<section id="features">
348-
<h2>Features<a class="headerlink" href="#features" title="Link to this heading"></a></h2>
349-
<ul class="simple">
350-
<li><p>Simple, well-documented API</p></li>
351-
<li><p>Blazing fast execution</p></li>
352-
<li><p>Built-in optimizer</p></li>
353-
<li><p>Library of composable base strategies and utilities</p></li>
354-
<li><p>Indicator-library-agnostic</p></li>
355-
<li><p>Supports <em>any</em> financial instrument with candlestick data</p></li>
356-
<li><p>Detailed results</p></li>
357-
<li><p>Interactive visualizations</p></li>
358-
</ul>
359-
<p><img alt="xkcd.com/1570" src="https://imgs.xkcd.com/comics/engineer_syllogism.png" /></p>
360-
</section>
361346
<section id="bugs">
362347
<h2>Bugs<a class="headerlink" href="#bugs" title="Link to this heading"></a></h2>
363348
<p>Before <a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues">reporting bugs</a> or posting to the
364-
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/discussions">discussion board</a>,
365-
please read <a class="reference external" href="https://lucit-backtesting.docs.lucit.tech/contributing.html">contributing guidelines</a>,
366-
particularly the section about crafting useful bug reports and <code class="docutils literal notranslate"><span class="pre">```</span></code>-fencing your code. We thank you!</p>
349+
<a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/discussions">discussion board</a> and
350+
please read <a class="reference external" href="https://lucit-backtesting.docs.lucit.tech/contributing.html">contributing guidelines</a>. We thank you!</p>
367351
</section>
368352
<section id="commercial-support">
369353
<h2>Commercial Support<a class="headerlink" href="#commercial-support" title="Link to this heading"></a></h2>
@@ -400,7 +384,6 @@ <h3><a href="index.html">Table of Contents</a></h3>
400384
<li><a class="reference internal" href="#description">Description</a></li>
401385
<li><a class="reference internal" href="#installation">Installation</a></li>
402386
<li><a class="reference internal" href="#usage">Usage</a></li>
403-
<li><a class="reference internal" href="#features">Features</a></li>
404387
<li><a class="reference internal" href="#bugs">Bugs</a></li>
405388
<li><a class="reference internal" href="#commercial-support">Commercial Support</a></li>
406389
</ul>
@@ -513,7 +496,7 @@ <h3>Navigation</h3>
513496
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
514497
&copy; <a href="/license.html">Copyright</a> 2024-2024, LUCIT Systems and Development. All Rights Reserved..
515498
See <a href="/license.html">License</a> for more information.<br />
516-
Last updated on Jun 07 2024 at 10:22 (CET).
499+
Last updated on Jun 07 2024 at 10:27 (CET).
517500
<a href="https://github.com/LUCIT-Systems-and-Development/lucit-backtesting/issues/new/choose">Found a bug</a>?
518501
<br />
519502
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:22 (CET).
230+
Last updated on Jun 07 2024 at 10:27 (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:22 (CET).
347+
Last updated on Jun 07 2024 at 10:27 (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)