Skip to content

Commit

Permalink
Update gh-pages to output generated at 7216175
Browse files Browse the repository at this point in the history
  • Loading branch information
cjdsellers committed Nov 12, 2023
1 parent fdbed25 commit 47c8fef
Show file tree
Hide file tree
Showing 252 changed files with 1,503 additions and 960 deletions.
Binary file modified develop/.doctrees/api_reference/accounting.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/adapters/betfair.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/adapters/binance.doctree
Binary file not shown.
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/analysis.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/backtest.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/cache.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/common.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/config.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/core.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/data.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/execution.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/indicators.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/infrastructure.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/live.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/model/currency.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/model/data.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/model/events.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/model/identifiers.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/model/instruments.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/model/objects.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/model/orderbook.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/model/orders.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/model/position.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/model/tick_scheme.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/msgbus.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/persistence.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/portfolio.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/risk.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/serialization.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/system.doctree
Binary file not shown.
Binary file modified develop/.doctrees/api_reference/trading.doctree
Binary file not shown.
Binary file modified develop/.doctrees/environment.pickle
Binary file not shown.
Binary file modified develop/.doctrees/integrations/ib.doctree
Binary file not shown.
294 changes: 222 additions & 72 deletions develop/_sources/integrations/ib.md.txt

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion develop/_sources/tutorials/backtest_high_level.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -178,4 +178,4 @@ node = BacktestNode(configs=[config])

results = node.run()
results
```
```
4 changes: 2 additions & 2 deletions develop/api_reference/adapters/binance.html
Original file line number Diff line number Diff line change
Expand Up @@ -13700,7 +13700,7 @@ <h3 id="module-nautilus_trader.adapters.binance.futures.data">
<em>
BinanceHttpClient
</em>
) – The binance HTTP client.
) – The Binance HTTP client.
</p>
</li>
<li>
Expand Down Expand Up @@ -20322,7 +20322,7 @@ <h3 id="module-nautilus_trader.adapters.binance.futures.execution">
<em>
BinanceHttpClient
</em>
) – The binance HTTP client.
) – The Binance HTTP client.
</p>
</li>
<li>
Expand Down
210 changes: 194 additions & 16 deletions develop/api_reference/adapters/interactive_brokers.html
Original file line number Diff line number Diff line change
Expand Up @@ -8596,6 +8596,126 @@ <h2 id="module-nautilus_trader.adapters.interactive_brokers.config">
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
host
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
str
</span>
<span class="w">
</span>
<span class="p">
<span class="pre">
|
</span>
</span>
<span class="w">
</span>
<span class="pre">
None
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
'127.0.0.1'
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
port
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
Optional
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="pre">
Literal
</span>
<span class="p">
<span class="pre">
[
</span>
</span>
<span class="m">
<span class="pre">
4001
</span>
</span>
<span class="p">
<span class="pre">
,
</span>
</span>
<span class="w">
</span>
<span class="m">
<span class="pre">
4002
</span>
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
<span class="p">
<span class="pre">
]
</span>
</span>
</span>
<span class="w">
</span>
<span class="o">
<span class="pre">
=
</span>
</span>
<span class="w">
</span>
<span class="default_value">
<span class="pre">
None
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
Expand Down Expand Up @@ -8850,6 +8970,42 @@ <h2 id="module-nautilus_trader.adapters.interactive_brokers.config">
.
</p>
</li>
<li>
<p>
<strong>
host
</strong>
(
<em>
str
</em>
<em>
,
</em>
<em>
optional
</em>
) – The hostname or ip address for the IB Gateway or TWS.
</p>
</li>
<li>
<p>
<strong>
port
</strong>
(
<em>
int
</em>
<em>
,
</em>
<em>
optional
</em>
) – The port for the gateway server (“paper” 4002, or “live” 4001).
</p>
</li>
<li>
<p>
<strong>
Expand Down Expand Up @@ -10631,6 +10787,22 @@ <h2 id="module-nautilus_trader.adapters.interactive_brokers.config">
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
host='127.0.0.1'
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
port=None
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
Expand Down Expand Up @@ -10695,7 +10867,7 @@ <h2 id="module-nautilus_trader.adapters.interactive_brokers.config">
at
</span>
<span class="pre">
0x7f3360e9f950&gt;
0x7f811d4dbe90&gt;
</span>
<span class="pre">
=
Expand Down Expand Up @@ -11477,6 +11649,12 @@ <h2 id="module-nautilus_trader.adapters.interactive_brokers.config">
<span class="pre">
password=None,
</span>
<span class="pre">
host='127.0.0.1',
</span>
<span class="pre">
port=None,
</span>
<span class="pre">
trading_mode='paper',
</span>
Expand Down Expand Up @@ -11600,19 +11778,7 @@ <h2 id="module-nautilus_trader.adapters.interactive_brokers.config">
<em>
int
</em>
<em>
,
</em>
<em>
default for "paper" 4002
</em>
<em>
, or
</em>
<em>
"live" 4001
</em>
) – The port for the gateway server.
) – The port for the gateway server (“paper” 4002, or “live” 4001).
</p>
</li>
<li>
Expand Down Expand Up @@ -12244,7 +12410,12 @@ <h2 id="module-nautilus_trader.adapters.interactive_brokers.data">
</a>
</p>
<p>
Provides a data client for the InteractiveBrokers exchange.
Provides a data client for the InteractiveBrokers exchange by using the
<cite>
Gateway
</cite>
to
stream market data.
</p>
<dl class="py method">
<dt class="sig sig-object py" id="nautilus_trader.adapters.interactive_brokers.data.InteractiveBrokersDataClient.connect">
Expand Down Expand Up @@ -17468,7 +17639,8 @@ <h2 id="module-nautilus_trader.adapters.interactive_brokers.execution">
</a>
</p>
<p>
Provides an execution client for Interactive Brokers TWS API.
Provides an execution client for Interactive Brokers TWS API, allowing for the
retrieval of account information and execution of orders.
</p>
<dl class="field-list simple">
<dt class="field-odd">
Expand Down Expand Up @@ -23860,6 +24032,12 @@ <h2 id="module-nautilus_trader.adapters.interactive_brokers.factories">
<span class="pre">
password=None,
</span>
<span class="pre">
host='127.0.0.1',
</span>
<span class="pre">
port=None,
</span>
<span class="pre">
trading_mode='paper',
</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
pub extern &quot;C&quot; fn time_event_accumulator_advance_clock(
accumulator: &amp;mut <a class="struct" href="struct.TimeEventAccumulatorAPI.html" title="struct nautilus_backtest::engine::TimeEventAccumulatorAPI">TimeEventAccumulatorAPI</a>,
clock: &amp;mut <a class="struct" href="../../nautilus_common/ffi/clock/struct.TestClock_API.html" title="struct nautilus_common::ffi::clock::TestClock_API">TestClock_API</a>,
to_time_ns: UnixNanos,
to_time_ns: <a class="type" href="../../nautilus_core/time/type.UnixNanos.html" title="type nautilus_core::time::UnixNanos">UnixNanos</a>,
set_time: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>
)</code></pre></section></div></main></body></html>
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `time_event_accumulator_drain` fn in crate `nautilus_backtest`."><title>time_event_accumulator_drain in nautilus_backtest::engine - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-9ee3a5e31a2afa3e.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="nautilus_backtest" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0-nightly (edf0b1db0 2023-11-10)" data-channel="nightly" data-search-js="search-8fbf244ebcf71464.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-9dd44ab47b99a0fb.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../nautilus_backtest/index.html">nautilus_backtest</a><span class="version">0.12.0</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In nautilus_backtest::engine</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../index.html">nautilus_backtest</a>::<wbr><a href="index.html">engine</a>::<wbr><a class="fn" href="#">time_event_accumulator_drain</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/nautilus_backtest/engine.rs.html#100-102">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>#[no_mangle]
pub extern &quot;C&quot; fn time_event_accumulator_drain(
accumulator: &amp;mut <a class="struct" href="struct.TimeEventAccumulatorAPI.html" title="struct nautilus_backtest::engine::TimeEventAccumulatorAPI">TimeEventAccumulatorAPI</a>
) -&gt; CVec</code></pre></section></div></main></body></html>
) -&gt; <a class="struct" href="../../nautilus_core/ffi/cvec/struct.CVec.html" title="struct nautilus_core::ffi::cvec::CVec">CVec</a></code></pre></section></div></main></body></html>
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
</div></details><details class="toggle method-toggle" open><summary><section id="method.advance_clock" class="method"><a class="src rightside" href="../../src/nautilus_backtest/engine.rs.html#36-40">source</a><h4 class="code-header">pub fn <a href="#method.advance_clock" class="fn">advance_clock</a>(
&amp;mut self,
clock: &amp;mut <a class="struct" href="../../nautilus_common/clock/struct.TestClock.html" title="struct nautilus_common::clock::TestClock">TestClock</a>,
to_time_ns: UnixNanos,
to_time_ns: <a class="type" href="../../nautilus_core/time/type.UnixNanos.html" title="type nautilus_core::time::UnixNanos">UnixNanos</a>,
set_time: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>
)</h4></section></summary><div class="docblock"><p>Advance the given clock to the <code>to_time_ns</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.drain" class="method"><a class="src rightside" href="../../src/nautilus_backtest/engine.rs.html#43-49">source</a><h4 class="code-header">pub fn <a href="#method.drain" class="fn">drain</a>(&amp;mut self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../nautilus_common/timer/struct.TimeEventHandler.html" title="struct nautilus_common::timer::TimeEventHandler">TimeEventHandler</a>&gt;</h4></section></summary><div class="docblock"><p>Drain the accumulated time event handlers in sorted order (by the events <code>ts_event</code>).</p>
Expand Down
Loading

0 comments on commit 47c8fef

Please sign in to comment.