Update gh-pages to output generated at 3bb1a03

nautechsystems · Jan 1, 2024 · e04b76e · e04b76e
1 parent aaf4df5
commit e04b76e
Show file tree

Hide file tree

Showing 1,502 changed files with 3,949 additions and 2,180 deletions.
diff --git a/develop/.doctrees/api_reference/accounting.doctree b/develop/.doctrees/api_reference/accounting.doctree
diff --git a/develop/.doctrees/api_reference/adapters/betfair.doctree b/develop/.doctrees/api_reference/adapters/betfair.doctree
diff --git a/develop/.doctrees/api_reference/adapters/binance.doctree b/develop/.doctrees/api_reference/adapters/binance.doctree
diff --git a/develop/.doctrees/api_reference/adapters/interactive_brokers.doctree b/develop/.doctrees/api_reference/adapters/interactive_brokers.doctree
diff --git a/develop/.doctrees/api_reference/analysis.doctree b/develop/.doctrees/api_reference/analysis.doctree
diff --git a/develop/.doctrees/api_reference/backtest.doctree b/develop/.doctrees/api_reference/backtest.doctree
diff --git a/develop/.doctrees/api_reference/cache.doctree b/develop/.doctrees/api_reference/cache.doctree
diff --git a/develop/.doctrees/api_reference/common.doctree b/develop/.doctrees/api_reference/common.doctree
diff --git a/develop/.doctrees/api_reference/config.doctree b/develop/.doctrees/api_reference/config.doctree
diff --git a/develop/.doctrees/api_reference/core.doctree b/develop/.doctrees/api_reference/core.doctree
diff --git a/develop/.doctrees/api_reference/data.doctree b/develop/.doctrees/api_reference/data.doctree
diff --git a/develop/.doctrees/api_reference/execution.doctree b/develop/.doctrees/api_reference/execution.doctree
diff --git a/develop/.doctrees/api_reference/indicators.doctree b/develop/.doctrees/api_reference/indicators.doctree
diff --git a/develop/.doctrees/api_reference/live.doctree b/develop/.doctrees/api_reference/live.doctree
diff --git a/develop/.doctrees/api_reference/model/book.doctree b/develop/.doctrees/api_reference/model/book.doctree
diff --git a/develop/.doctrees/api_reference/model/data.doctree b/develop/.doctrees/api_reference/model/data.doctree
diff --git a/develop/.doctrees/api_reference/model/events.doctree b/develop/.doctrees/api_reference/model/events.doctree
diff --git a/develop/.doctrees/api_reference/model/identifiers.doctree b/develop/.doctrees/api_reference/model/identifiers.doctree
diff --git a/develop/.doctrees/api_reference/model/instruments.doctree b/develop/.doctrees/api_reference/model/instruments.doctree
diff --git a/develop/.doctrees/api_reference/model/objects.doctree b/develop/.doctrees/api_reference/model/objects.doctree
diff --git a/develop/.doctrees/api_reference/model/orders.doctree b/develop/.doctrees/api_reference/model/orders.doctree
diff --git a/develop/.doctrees/api_reference/model/position.doctree b/develop/.doctrees/api_reference/model/position.doctree
diff --git a/develop/.doctrees/api_reference/model/tick_scheme.doctree b/develop/.doctrees/api_reference/model/tick_scheme.doctree
diff --git a/develop/.doctrees/api_reference/persistence.doctree b/develop/.doctrees/api_reference/persistence.doctree
diff --git a/develop/.doctrees/api_reference/portfolio.doctree b/develop/.doctrees/api_reference/portfolio.doctree
diff --git a/develop/.doctrees/api_reference/risk.doctree b/develop/.doctrees/api_reference/risk.doctree
diff --git a/develop/.doctrees/api_reference/serialization.doctree b/develop/.doctrees/api_reference/serialization.doctree
diff --git a/develop/.doctrees/api_reference/system.doctree b/develop/.doctrees/api_reference/system.doctree
diff --git a/develop/.doctrees/api_reference/trading.doctree b/develop/.doctrees/api_reference/trading.doctree
diff --git a/develop/.doctrees/environment.pickle b/develop/.doctrees/environment.pickle
diff --git a/develop/api_reference/adapters/betfair.html b/develop/api_reference/adapters/betfair.html
@@ -1635,10 +1635,10 @@
                  </a>
                 </li>
                 <li class="md-nav__item">
-                 <a class="md-nav__link" href="#nautilus_trader.adapters.betfair.data_types.BSPOrderBookDelta.from_pyo3">
+                 <a class="md-nav__link" href="#nautilus_trader.adapters.betfair.data_types.BSPOrderBookDelta.from_pyo3_list">
                   <code class="docutils literal notranslate">
                    <span class="pre">
-                    BSPOrderBookDelta.from_pyo3()
+                    BSPOrderBookDelta.from_pyo3_list()
                    </span>
                   </code>
                  </a>
@@ -11378,7 +11378,7 @@ <h2 id="module-nautilus_trader.adapters.betfair.data_types">
             </dd>
            </dl>
            <dl class="py method">
-            <dt class="sig sig-object py" id="nautilus_trader.adapters.betfair.data_types.BSPOrderBookDelta.from_pyo3">
+            <dt class="sig sig-object py" id="nautilus_trader.adapters.betfair.data_types.BSPOrderBookDelta.from_pyo3_list">
              <em class="property">
               <span class="pre">
                static
@@ -11388,7 +11388,7 @@ <h2 id="module-nautilus_trader.adapters.betfair.data_types">
              </em>
              <span class="sig-name descname">
               <span class="pre">
-               from_pyo3
+               from_pyo3_list
               </span>
              </span>
              <span class="sig-paren">
@@ -11432,13 +11432,13 @@ <h2 id="module-nautilus_trader.adapters.betfair.data_types">
                </span>
               </span>
              </span>
-             <a class="headerlink" href="#nautilus_trader.adapters.betfair.data_types.BSPOrderBookDelta.from_pyo3" title="Permalink to this definition">
+             <a class="headerlink" href="#nautilus_trader.adapters.betfair.data_types.BSPOrderBookDelta.from_pyo3_list" title="Permalink to this definition">
               ¶
              </a>
             </dt>
             <dd>
              <p>
-              Return order book deltas converted from the given pyo3 provided objects.
+              Return legacy Cython order book deltas converted from the given Rust pyo3 objects.
              </p>
              <dl class="field-list simple">
               <dt class="field-odd">

diff --git a/develop/api_reference/adapters/binance.html b/develop/api_reference/adapters/binance.html
@@ -1171,10 +1171,10 @@
                  </a>
                 </li>
                 <li class="md-nav__item">
-                 <a class="md-nav__link" href="#nautilus_trader.adapters.binance.common.types.BinanceBar.from_pyo3">
+                 <a class="md-nav__link" href="#nautilus_trader.adapters.binance.common.types.BinanceBar.from_pyo3_list">
                   <code class="docutils literal notranslate">
                    <span class="pre">
-                    BinanceBar.from_pyo3()
+                    BinanceBar.from_pyo3_list()
                    </span>
                   </code>
                  </a>
@@ -11736,7 +11736,7 @@ <h2 id="module-nautilus_trader.adapters.binance.common.types">
             </dd>
            </dl>
            <dl class="py method">
-            <dt class="sig sig-object py" id="nautilus_trader.adapters.binance.common.types.BinanceBar.from_pyo3">
+            <dt class="sig sig-object py" id="nautilus_trader.adapters.binance.common.types.BinanceBar.from_pyo3_list">
              <em class="property">
               <span class="pre">
                static
@@ -11746,7 +11746,7 @@ <h2 id="module-nautilus_trader.adapters.binance.common.types">
              </em>
              <span class="sig-name descname">
               <span class="pre">
-               from_pyo3
+               from_pyo3_list
               </span>
              </span>
              <span class="sig-paren">
@@ -11790,13 +11790,13 @@ <h2 id="module-nautilus_trader.adapters.binance.common.types">
                </span>
               </span>
              </span>
-             <a class="headerlink" href="#nautilus_trader.adapters.binance.common.types.BinanceBar.from_pyo3" title="Permalink to this definition">
+             <a class="headerlink" href="#nautilus_trader.adapters.binance.common.types.BinanceBar.from_pyo3_list" title="Permalink to this definition">
               ¶
              </a>
             </dt>
             <dd>
              <p>
-              Return bars converted from the given pyo3 provided objects.
+              Return legacy Cython bars converted from the given pyo3 Rust objects.
              </p>
              <dl class="field-list simple">
               <dt class="field-odd">

diff --git a/develop/api_reference/adapters/interactive_brokers.html b/develop/api_reference/adapters/interactive_brokers.html
@@ -11887,7 +11887,7 @@ <h2 id="module-nautilus_trader.adapters.interactive_brokers.config">
               at
              </span>
              <span class="pre">
-              0x7fdc63a32010&gt;
+              0x7fc646104f90&gt;
              </span>
              <span class="pre">
               =

diff --git a/develop/api_reference/model/data.html b/develop/api_reference/model/data.html
@@ -754,10 +754,10 @@
                </a>
               </li>
               <li class="md-nav__item">
-               <a class="md-nav__link" href="#nautilus_trader.model.data.Bar.from_pyo3">
+               <a class="md-nav__link" href="#nautilus_trader.model.data.Bar.from_pyo3_list">
                 <code class="docutils literal notranslate">
                  <span class="pre">
-                  Bar.from_pyo3()
+                  Bar.from_pyo3_list()
                  </span>
                 </code>
                </a>
@@ -1591,10 +1591,10 @@
                </a>
               </li>
               <li class="md-nav__item">
-               <a class="md-nav__link" href="#nautilus_trader.model.data.OrderBookDelta.from_pyo3">
+               <a class="md-nav__link" href="#nautilus_trader.model.data.OrderBookDelta.from_pyo3_list">
                 <code class="docutils literal notranslate">
                  <span class="pre">
-                  OrderBookDelta.from_pyo3()
+                  OrderBookDelta.from_pyo3_list()
                  </span>
                 </code>
                </a>
@@ -1900,10 +1900,10 @@
                </a>
               </li>
               <li class="md-nav__item">
-               <a class="md-nav__link" href="#nautilus_trader.model.data.QuoteTick.from_pyo3">
+               <a class="md-nav__link" href="#nautilus_trader.model.data.QuoteTick.from_pyo3_list">
                 <code class="docutils literal notranslate">
                  <span class="pre">
-                  QuoteTick.from_pyo3()
+                  QuoteTick.from_pyo3_list()
                  </span>
                 </code>
                </a>
@@ -2083,10 +2083,10 @@
                </a>
               </li>
               <li class="md-nav__item">
-               <a class="md-nav__link" href="#nautilus_trader.model.data.TradeTick.from_pyo3">
+               <a class="md-nav__link" href="#nautilus_trader.model.data.TradeTick.from_pyo3_list">
                 <code class="docutils literal notranslate">
                  <span class="pre">
-                  TradeTick.from_pyo3()
+                  TradeTick.from_pyo3_list()
                  </span>
                 </code>
                </a>
@@ -2815,7 +2815,7 @@ <h1 id="api-reference-model-data--page-root">
            </dd>
           </dl>
           <dl class="py method">
-           <dt class="sig sig-object py" id="nautilus_trader.model.data.Bar.from_pyo3">
+           <dt class="sig sig-object py" id="nautilus_trader.model.data.Bar.from_pyo3_list">
             <em class="property">
              <span class="pre">
               static
@@ -2825,7 +2825,7 @@ <h1 id="api-reference-model-data--page-root">
             </em>
             <span class="sig-name descname">
              <span class="pre">
-              from_pyo3
+              from_pyo3_list
              </span>
             </span>
             <span class="sig-paren">
@@ -2869,13 +2869,13 @@ <h1 id="api-reference-model-data--page-root">
               </span>
              </span>
             </span>
-            <a class="headerlink" href="#nautilus_trader.model.data.Bar.from_pyo3" title="Permalink to this definition">
+            <a class="headerlink" href="#nautilus_trader.model.data.Bar.from_pyo3_list" title="Permalink to this definition">
              ¶
             </a>
            </dt>
            <dd>
             <p>
-             Return bars converted from the given pyo3 provided objects.
+             Return legacy Cython bars converted from the given pyo3 Rust objects.
             </p>
             <dl class="field-list simple">
              <dt class="field-odd">
@@ -8296,7 +8296,16 @@ <h1 id="api-reference-model-data--page-root">
              BookOrder
             </span>
             <span class="pre">
-             order
+             order:
+            </span>
+            <span class="pre">
+             BookOrder
+            </span>
+            <span class="pre">
+             |
+            </span>
+            <span class="pre">
+             None
             </span>
            </span>
           </em>
@@ -8427,13 +8436,13 @@ <h1 id="api-reference-model-data--page-root">
                <strong>
                 order
                </strong>
-               (
-               <a class="reference internal" href="#nautilus_trader.model.data.BookOrder" title="nautilus_trader.model.data.BookOrder">
-                <em>
-                 BookOrder
-                </em>
-               </a>
-               ) – The book order for the delta.
+               (BookOrder, optional with no default so
+               <code class="docutils literal notranslate">
+                <span class="pre">
+                 None
+                </span>
+               </code>
+               must be passed explicitly) – The book order for the delta.
               </p>
              </li>
              <li>
@@ -8503,11 +8512,6 @@ <h1 id="api-reference-model-data--page-root">
                 default 0
                </em>
                ) – The unique sequence number for the update.
-If default 0 then will increment the
-               <cite>
-                sequence
-               </cite>
-               .
               </p>
              </li>
             </ul>
@@ -8861,7 +8865,7 @@ <h1 id="api-reference-model-data--page-root">
            </dd>
           </dl>
           <dl class="py method">
-           <dt class="sig sig-object py" id="nautilus_trader.model.data.OrderBookDelta.from_pyo3">
+           <dt class="sig sig-object py" id="nautilus_trader.model.data.OrderBookDelta.from_pyo3_list">
             <em class="property">
              <span class="pre">
               static
@@ -8871,7 +8875,7 @@ <h1 id="api-reference-model-data--page-root">
             </em>
             <span class="sig-name descname">
              <span class="pre">
-              from_pyo3
+              from_pyo3_list
              </span>
             </span>
             <span class="sig-paren">
@@ -8915,13 +8919,13 @@ <h1 id="api-reference-model-data--page-root">
               </span>
              </span>
             </span>
-            <a class="headerlink" href="#nautilus_trader.model.data.OrderBookDelta.from_pyo3" title="Permalink to this definition">
+            <a class="headerlink" href="#nautilus_trader.model.data.OrderBookDelta.from_pyo3_list" title="Permalink to this definition">
              ¶
             </a>
            </dt>
            <dd>
             <p>
-             Return order book deltas converted from the given pyo3 provided objects.
+             Return legacy Cython order book deltas converted from the given Rust pyo3 objects.
             </p>
             <dl class="field-list simple">
              <dt class="field-odd">
@@ -10022,7 +10026,7 @@ <h1 id="api-reference-model-data--page-root">
            </code>
           </p>
           <p>
-           Represents bulk
+           Represents a grouped batch of
            <cite>
             OrderBookDelta
            </cite>
@@ -11279,7 +11283,7 @@ <h1 id="api-reference-model-data--page-root">
            </dd>
           </dl>
           <dl class="py method">
-           <dt class="sig sig-object py" id="nautilus_trader.model.data.QuoteTick.from_pyo3">
+           <dt class="sig sig-object py" id="nautilus_trader.model.data.QuoteTick.from_pyo3_list">
             <em class="property">
              <span class="pre">
               static
@@ -11289,7 +11293,7 @@ <h1 id="api-reference-model-data--page-root">
             </em>
             <span class="sig-name descname">
              <span class="pre">
-              from_pyo3
+              from_pyo3_list
              </span>
             </span>
             <span class="sig-paren">
@@ -11333,13 +11337,13 @@ <h1 id="api-reference-model-data--page-root">
               </span>
              </span>
             </span>
-            <a class="headerlink" href="#nautilus_trader.model.data.QuoteTick.from_pyo3" title="Permalink to this definition">
+            <a class="headerlink" href="#nautilus_trader.model.data.QuoteTick.from_pyo3_list" title="Permalink to this definition">
              ¶
             </a>
            </dt>
            <dd>
             <p>
-             Return quote ticks converted from the given pyo3 provided objects.
+             Return legacy Cython quote ticks converted from the given pyo3 Rust objects.
             </p>
             <dl class="field-list simple">
              <dt class="field-odd">
@@ -12948,7 +12952,7 @@ <h1 id="api-reference-model-data--page-root">
            </dd>
           </dl>
           <dl class="py method">
-           <dt class="sig sig-object py" id="nautilus_trader.model.data.TradeTick.from_pyo3">
+           <dt class="sig sig-object py" id="nautilus_trader.model.data.TradeTick.from_pyo3_list">
             <em class="property">
              <span class="pre">
               static
@@ -12958,7 +12962,7 @@ <h1 id="api-reference-model-data--page-root">
             </em>
             <span class="sig-name descname">
              <span class="pre">
-              from_pyo3
+              from_pyo3_list
              </span>
             </span>
             <span class="sig-paren">
@@ -13002,13 +13006,13 @@ <h1 id="api-reference-model-data--page-root">
               </span>
              </span>
             </span>
-            <a class="headerlink" href="#nautilus_trader.model.data.TradeTick.from_pyo3" title="Permalink to this definition">
+            <a class="headerlink" href="#nautilus_trader.model.data.TradeTick.from_pyo3_list" title="Permalink to this definition">
              ¶
             </a>
            </dt>
            <dd>
             <p>
-             Return trade ticks converted from the given pyo3 provided objects.
+             Return legacy Cython trade ticks converted from the given pyo3 Rust objects.
             </p>
             <dl class="field-list simple">
              <dt class="field-odd">