2.8.0 RC docs

LUCIT-Systems-and-Development · Nov 3, 2024 · 81cbdf5 · 81cbdf5
1 parent 0c6ce4d
commit 81cbdf5
Show file tree

Hide file tree

Showing 18 changed files with 25 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -165,7 +165,7 @@ provides local order books for the Binance Exchanges
 [Binance Futures](https://binance-docs.github.io/apidocs/futures/en/#websocket-market-streams) 
 ([+Testnet](https://testnet.binancefuture.com)) and [Binance US](https://www.binance.us/).
 
-The algorithm of the DepthCache management was designed according to these instructions:
+### The algorithm of the DepthCache management was designed according to these instructions:
 
 ***Since, according to Binance's predefined algorithm, 
 [all levels > 1000 would be orphaned and remain forever between valid levels](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/45)

diff --git a/dev/sphinx/source/readme.md b/dev/sphinx/source/readme.md
@@ -165,7 +165,7 @@ provides local order books for the Binance Exchanges
 [Binance Futures](https://binance-docs.github.io/apidocs/futures/en/#websocket-market-streams) 
 ([+Testnet](https://testnet.binancefuture.com)) and [Binance US](https://www.binance.us/).
 
-The algorithm of the DepthCache management was designed according to these instructions:
+### The algorithm of the DepthCache management was designed according to these instructions:
 
 ***Since, according to Binance's predefined algorithm, 
 [all levels > 1000 would be orphaned and remain forever between valid levels](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/45)

diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -251,7 +251,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> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Nov 03 2024 at 13:59 (CET).
+    Last updated on Nov 03 2024 at 14:03 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/_modules/unicorn_binance_local_depth_cache/manager.html b/docs/_modules/unicorn_binance_local_depth_cache/manager.html
@@ -182,7 +182,7 @@ <h1>Source code for unicorn_binance_local_depth_cache.manager</h1><div class="hi
 
 
 <span class="n">__app_name__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;unicorn-binance-local-depth-cache&quot;</span>
-<span class="n">__version__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;2.8.0.dev&quot;</span>
+<span class="n">__version__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;2.8.0&quot;</span>
 <span class="n">__logger__</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">&quot;unicorn_binance_local_depth_cache&quot;</span><span class="p">)</span>
 
 <span class="n">logger</span> <span class="o">=</span> <span class="n">__logger__</span>
@@ -1655,7 +1655,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> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Nov 03 2024 at 13:59 (CET).
+    Last updated on Nov 03 2024 at 14:03 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/_sources/readme.md.txt b/docs/_sources/readme.md.txt
@@ -165,7 +165,7 @@ provides local order books for the Binance Exchanges
 [Binance Futures](https://binance-docs.github.io/apidocs/futures/en/#websocket-market-streams) 
 ([+Testnet](https://testnet.binancefuture.com)) and [Binance US](https://www.binance.us/).
 
-The algorithm of the DepthCache management was designed according to these instructions:
+### The algorithm of the DepthCache management was designed according to these instructions:
 
 ***Since, according to Binance's predefined algorithm, 
 [all levels > 1000 would be orphaned and remain forever between valid levels](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/45)

diff --git a/docs/changelog.html b/docs/changelog.html
@@ -1029,7 +1029,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> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Nov 03 2024 at 13:59 (CET).
+    Last updated on Nov 03 2024 at 14:03 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/code_of_conduct.html b/docs/code_of_conduct.html
@@ -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> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Nov 03 2024 at 13:59 (CET).
+    Last updated on Nov 03 2024 at 14:03 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/contributing.html b/docs/contributing.html
@@ -334,7 +334,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> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Nov 03 2024 at 13:59 (CET).
+    Last updated on Nov 03 2024 at 14:03 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -520,7 +520,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> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Nov 03 2024 at 13:59 (CET).
+    Last updated on Nov 03 2024 at 14:03 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/index.html b/docs/index.html
@@ -188,6 +188,7 @@ <h1>Welcome to unicorn-binance-local-depth-cache’s documentation!<a class="hea
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="readme.html#description">Description</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="readme.html#the-algorithm-of-the-depthcache-management-was-designed-according-to-these-instructions">The algorithm of the DepthCache management was designed according to these instructions:</a></li>
 <li class="toctree-l3"><a class="reference internal" href="readme.html#why-a-local-depthcache">Why a local DepthCache?</a></li>
 <li class="toctree-l3"><a class="reference internal" href="readme.html#what-are-the-benefits-of-the-unicorn-binance-local-depth-cache">What are the benefits of the UNICORN Binance Local Depth Cache?</a></li>
 </ul>
@@ -511,7 +512,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> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Nov 03 2024 at 13:59 (CET).
+    Last updated on Nov 03 2024 at 14:03 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/license.html b/docs/license.html
@@ -389,7 +389,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> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Nov 03 2024 at 13:59 (CET).
+    Last updated on Nov 03 2024 at 14:03 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/modules.html b/docs/modules.html
@@ -387,7 +387,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> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Nov 03 2024 at 13:59 (CET).
+    Last updated on Nov 03 2024 at 14:03 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -287,7 +287,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> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Nov 03 2024 at 13:59 (CET).
+    Last updated on Nov 03 2024 at 14:03 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/readme.html b/docs/readme.html
@@ -85,6 +85,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
 </ul>
 </li>
 <li><a class="reference internal" href="#description">Description</a><ul>
+<li><a class="reference internal" href="#the-algorithm-of-the-depthcache-management-was-designed-according-to-these-instructions">The algorithm of the DepthCache management was designed according to these instructions:</a></li>
 <li><a class="reference internal" href="#why-a-local-depthcache">Why a local DepthCache?</a></li>
 <li><a class="reference internal" href="#what-are-the-benefits-of-the-unicorn-binance-local-depth-cache">What are the benefits of the UNICORN Binance Local Depth Cache?</a></li>
 </ul>
@@ -403,7 +404,8 @@ <h2>Description<a class="headerlink" href="#description" title="Link to this hea
 <a class="reference external" href="https://github.com/binance-exchange/binance-official-api-docs">Binance</a> (<a class="reference external" href="https://testnet.binance.vision/">+Testnet</a>),
 <a class="reference external" href="https://binance-docs.github.io/apidocs/futures/en/#websocket-market-streams">Binance Futures</a>
 (<a class="reference external" href="https://testnet.binancefuture.com">+Testnet</a>) and <a class="reference external" href="https://www.binance.us/">Binance US</a>.</p>
-<p>The algorithm of the DepthCache management was designed according to these instructions:</p>
+<section id="the-algorithm-of-the-depthcache-management-was-designed-according-to-these-instructions">
+<h3>The algorithm of the DepthCache management was designed according to these instructions:<a class="headerlink" href="#the-algorithm-of-the-depthcache-management-was-designed-according-to-these-instructions" title="Link to this heading">¶</a></h3>
 <p><em><strong>Since, according to Binance’s predefined algorithm,
 <a class="reference external" href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/45">all levels &gt; 1000 would be orphaned and remain forever between valid levels</a>
 , UBLDC removes them as soon as they exceed the thousandth position.</strong></em></p>
@@ -425,6 +427,7 @@ <h2>Description<a class="headerlink" href="#description" title="Link to this hea
 <p>The DepthCache will immediately start an automatic re-initialization if a gap in the UpdateID`s is detected (missing
 update event) or if the websocket connection is interrupted. As soon as this happens the state of the DepthCache is set
 to “out of sync” and when accessing the cache the exception <a class="reference external" href="https://unicorn-binance-local-depth-cache.docs.lucit.tech/unicorn_binance_local_depth_cache.html?highlight=is_depth_cache_synchronized#unicorn_binance_local_depth_cache.exceptions.DepthCacheOutOfSync">‘DepthCacheOutOfSync’</a> is thrown.</p>
+</section>
 <section id="why-a-local-depthcache">
 <h3>Why a local DepthCache?<a class="headerlink" href="#why-a-local-depthcache" title="Link to this heading">¶</a></h3>
 <p>A local DepthCache is the fastest way to access the current order book depth at any time while transferring as little data as necessary. A REST snapshot takes a lot of time and the amount of data that is transferred is relatively large. Continuous full transmission of the order book via websocket is faster, but the amount of data is huge. A local depth_cache is initialized once with a REST snapshot and then handles Diff. Depth updates applied by the websocket connection. By transferring a small amount of data (only the changes), a local depth_cache is kept in sync in real time and also allows extremely fast (local) access to the data without exceeding the <a class="reference external" href="https://www.binance.com/en/support/faq/360004492232">Binance request weight limits</a>.</p>
@@ -722,6 +725,7 @@ <h3><a href="index.html">Table of Contents</a></h3>
 </ul>
 </li>
 <li><a class="reference internal" href="#description">Description</a><ul>
+<li><a class="reference internal" href="#the-algorithm-of-the-depthcache-management-was-designed-according-to-these-instructions">The algorithm of the DepthCache management was designed according to these instructions:</a></li>
 <li><a class="reference internal" href="#why-a-local-depthcache">Why a local DepthCache?</a></li>
 <li><a class="reference internal" href="#what-are-the-benefits-of-the-unicorn-binance-local-depth-cache">What are the benefits of the UNICORN Binance Local Depth Cache?</a></li>
 </ul>
@@ -875,7 +879,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> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Nov 03 2024 at 13:59 (CET).
+    Last updated on Nov 03 2024 at 14:03 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/search.html b/docs/search.html
@@ -225,7 +225,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> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Nov 03 2024 at 13:59 (CET).
+    Last updated on Nov 03 2024 at 14:03 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/security.html b/docs/security.html
@@ -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> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Nov 03 2024 at 13:59 (CET).
+    Last updated on Nov 03 2024 at 14:03 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/unicorn_binance_local_depth_cache.html b/docs/unicorn_binance_local_depth_cache.html
@@ -1056,7 +1056,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> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Nov 03 2024 at 13:59 (CET).
+    Last updated on Nov 03 2024 at 14:03 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-local-depth-cache/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.