Skip to content

Commit

Permalink
Update gh-pages to output generated at fdbfdf3
Browse files Browse the repository at this point in the history
  • Loading branch information
cjdsellers committed Oct 28, 2023
1 parent 0443d8e commit 1e082b4
Show file tree
Hide file tree
Showing 180 changed files with 544 additions and 331 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/concepts/execution.doctree
Binary file not shown.
Binary file modified develop/.doctrees/concepts/orders.doctree
Binary file not shown.
Binary file modified develop/.doctrees/environment.pickle
Binary file not shown.
2 changes: 1 addition & 1 deletion develop/_sources/concepts/execution.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ e.g. `O-20230404-001-000-E1` (for the first spawned order)

```{note}
The "primary" and "secondary" / "spawn" terminology was specifically chosen to avoid conflict
or confusion with the "parent" and "child" contingency orders terminology (an execution algorithm may also deal with contingent orders).
or confusion with the "parent" and "child" contingent orders terminology (an execution algorithm may also deal with contingent orders).
```

### Managing execution algorithm orders
Expand Down
2 changes: 1 addition & 1 deletion develop/_sources/concepts/orders.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ of the stop price based on the offset from the 'market' (bid, ask or last price
- `TICKS` - The offset is based on a number of ticks
- `PRICE_TIER` - The offset is based on an exchange specific price tier

### Contingency Orders
### Contingent Orders
More advanced relationships can be specified between orders such as assigning child order(s) which will only
trigger when the parent order is activated or filled, or linking orders together which will cancel or reduce in quantity
contingent on each other. More documentation for these options can be found in the [advanced order guide](advanced/advanced_orders.md).
Expand Down
2 changes: 1 addition & 1 deletion develop/api_reference/adapters/interactive_brokers.html
Original file line number Diff line number Diff line change
Expand Up @@ -10699,7 +10699,7 @@ <h2 id="module-nautilus_trader.adapters.interactive_brokers.config">
at
</span>
<span class="pre">
0x7efea9667e10&gt;
0x7f5283738f90&gt;
</span>
<span class="pre">
=
Expand Down
97 changes: 97 additions & 0 deletions develop/api_reference/backtest.html
Original file line number Diff line number Diff line change
Expand Up @@ -2260,6 +2260,15 @@
</code>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#nautilus_trader.backtest.exchange.SimulatedExchange.support_contingent_orders">
<code class="docutils literal notranslate">
<span class="pre">
SimulatedExchange.support_contingent_orders
</span>
</code>
</a>
</li>
<li class="md-nav__item">
<a class="md-nav__link" href="#nautilus_trader.backtest.exchange.SimulatedExchange.support_gtd_orders">
<code class="docutils literal notranslate">
Expand Down Expand Up @@ -11650,6 +11659,18 @@ <h1 id="api-reference-backtest--page-root">
<span class="pre">
True,
</span>
<span class="pre">
support_contingent_orders:
</span>
<span class="pre">
bool
</span>
<span class="pre">
=
</span>
<span class="pre">
True,
</span>
<span class="pre">
use_position_ids:
</span>
Expand Down Expand Up @@ -12049,6 +12070,25 @@ <h1 id="api-reference-backtest--page-root">
) – If orders with GTD time in force will be supported by the venue.
</p>
</li>
<li>
<p>
<strong>
support_contingent_orders
</strong>
(
<em>
bool
</em>
<em>
,
</em>
<em>
default True
</em>
) – If contingent orders will be supported/respected by the venue.
If False then its expected the strategy will be managing any contingent orders.
</p>
</li>
<li>
<p>
<strong>
Expand Down Expand Up @@ -14044,6 +14084,12 @@ <h1 id="api-reference-backtest--page-root">
<span class="pre">
bool
</span>
<span class="pre">
support_contingent_orders=True,
</span>
<span class="pre">
bool
</span>
<span class="pre">
use_position_ids=True,
</span>
Expand Down Expand Up @@ -14398,6 +14444,25 @@ <h1 id="api-reference-backtest--page-root">
) – If orders with GTD time in force will be supported by the venue.
</p>
</li>
<li>
<p>
<strong>
support_contingent_orders
</strong>
(
<em>
bool
</em>
<em>
,
</em>
<em>
default True
</em>
) – If contingent orders will be supported/respected by the venue.
If False then its expected the strategy will be managing any contingent orders.
</p>
</li>
<li>
<p>
<strong>
Expand Down Expand Up @@ -17093,6 +17158,38 @@ <h1 id="api-reference-backtest--page-root">
</dl>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nautilus_trader.backtest.exchange.SimulatedExchange.support_contingent_orders">
<span class="sig-name descname">
<span class="pre">
support_contingent_orders
</span>
</span>
<a class="headerlink" href="#nautilus_trader.backtest.exchange.SimulatedExchange.support_contingent_orders" title="Permalink to this definition">
</a>
</dt>
<dd>
<p>
If contingent orders will be supported/respected by the venue.
</p>
<dl class="field-list simple">
<dt class="field-odd">
Returns
<span class="colon">
:
</span>
</dt>
<dd class="field-odd">
<p>
<cite>
bool
</cite>
</p>
</dd>
</dl>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="nautilus_trader.backtest.exchange.SimulatedExchange.support_gtd_orders">
<span class="sig-name descname">
Expand Down
45 changes: 42 additions & 3 deletions develop/api_reference/config.html
Original file line number Diff line number Diff line change
Expand Up @@ -10471,7 +10471,7 @@ <h2 id="module-nautilus_trader.config.common">
<em class="sig-param">
<span class="n">
<span class="pre">
manage_contingencies
manage_contingent_orders
</span>
</span>
<span class="p">
Expand Down Expand Up @@ -10656,7 +10656,7 @@ <h2 id="module-nautilus_trader.config.common">
<li>
<p>
<strong>
manage_contingencies
manage_contingent_orders
</strong>
(
<em>
Expand All @@ -10672,7 +10672,12 @@ <h2 id="module-nautilus_trader.config.common">
<strong>
open
</strong>
contingency orders should be managed automatically by the strategy.
contingent orders should be managed automatically by the strategy.
Any emulated orders which are active local will be managed by the
<cite>
OrderEmulator
</cite>
instead.
</p>
</li>
<li>
Expand Down Expand Up @@ -17971,6 +17976,40 @@ <h2 id="module-nautilus_trader.config.backtest">
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
support_contingent_orders
</span>
</span>
<span class="p">
<span class="pre">
:
</span>
</span>
<span class="w">
</span>
<span class="n">
<span class="pre">
bool
</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">
True
</span>
</span>
</em>
,
<em class="sig-param">
<span class="n">
<span class="pre">
Expand Down
Loading

0 comments on commit 1e082b4

Please sign in to comment.