Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@oliver-zehentleitner
oliver-zehentleitner committed Nov 11, 2023
1 parent 7a3d4fe commit 3173fc2
Show file tree
Hide file tree
Showing 20 changed files with 22 additions and 49 deletions.
6 changes: 0 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,6 @@ https://github.com/binance-us/binance-official-api-docs/blob/master/rest-api.md#
print(f"Used weight: {ubra.get_used_weight()}")
```

### Stop `ubra` after usage to avoid memory leaks

```
ubra.stop_manager()
```

## Send data to Binance REST API Endpoints
### Initiate `BinanceRestApiManager()`

Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ <h3>Navigation</h3>
<div class="footer">
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Nov 11 2023 at 16:58 (CET).
Last updated on Nov 11 2023 at 16:59 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/unicorn_binance_rest_api/exceptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -409,7 +409,7 @@ <h3>Navigation</h3>
<div class="footer">
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Nov 11 2023 at 16:58 (CET).
Last updated on Nov 11 2023 at 16:59 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/unicorn_binance_rest_api/helpers.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ <h3>Navigation</h3>
<div class="footer">
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Nov 11 2023 at 16:58 (CET).
Last updated on Nov 11 2023 at 16:59 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/unicorn_binance_rest_api/manager.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8143,7 +8143,7 @@ <h3>Navigation</h3>
<div class="footer">
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Nov 11 2023 at 16:58 (CET).
Last updated on Nov 11 2023 at 16:59 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
6 changes: 0 additions & 6 deletions docs/_sources/readme.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,6 @@ https://github.com/binance-us/binance-official-api-docs/blob/master/rest-api.md#
print(f"Used weight: {ubra.get_used_weight()}")
```

### Stop `ubra` after usage to avoid memory leaks

```
ubra.stop_manager()
```

## Send data to Binance REST API Endpoints
### Initiate `BinanceRestApiManager()`

Expand Down
2 changes: 1 addition & 1 deletion docs/changelog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -755,7 +755,7 @@ <h3>Navigation</h3>
<div class="footer">
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Nov 11 2023 at 16:58 (CET).
Last updated on Nov 11 2023 at 16:59 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/code_of_conduct.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ <h3>Navigation</h3>
<div class="footer">
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Nov 11 2023 at 16:58 (CET).
Last updated on Nov 11 2023 at 16:59 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ <h3>Navigation</h3>
<div class="footer">
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Nov 11 2023 at 16:58 (CET).
Last updated on Nov 11 2023 at 16:59 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1100,7 +1100,7 @@ <h3>Navigation</h3>
<div class="footer">
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Nov 11 2023 at 16:58 (CET).
Last updated on Nov 11 2023 at 16:59 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
5 changes: 2 additions & 3 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,13 +178,12 @@ <h1>Welcome to unicorn-binance-rest-api’s documentation!<a class="headerlink"
<li class="toctree-l3"><a class="reference internal" href="readme.html#print-a-snapshot-of-an-order-book">Print a snapshot of an order book</a></li>
<li class="toctree-l3"><a class="reference internal" href="readme.html#get-all-symbol-prices">Get all symbol prices</a></li>
<li class="toctree-l3"><a class="reference internal" href="readme.html#get-the-used-weight">Get the used weight</a></li>
<li class="toctree-l3"><a class="reference internal" href="readme.html#stop-ubra-after-usage-to-avoid-memory-leaks">Stop <code class="docutils literal notranslate"><span class="pre">ubra</span></code> after usage to avoid memory leaks</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="readme.html#send-data-to-binance-rest-api-endpoints">Send data to Binance REST API Endpoints</a><ul>
<li class="toctree-l3"><a class="reference internal" href="readme.html#id1">Initiate <code class="docutils literal notranslate"><span class="pre">BinanceRestApiManager()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="readme.html#buy-btc-with-a-market-order-using-100-usdt">Buy BTC with a market order using 100 USDT</a></li>
<li class="toctree-l3"><a class="reference internal" href="readme.html#id2">Stop <code class="docutils literal notranslate"><span class="pre">ubra</span></code> after usage to avoid memory leaks</a></li>
<li class="toctree-l3"><a class="reference internal" href="readme.html#stop-ubra-after-usage-to-avoid-memory-leaks">Stop <code class="docutils literal notranslate"><span class="pre">ubra</span></code> after usage to avoid memory leaks</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="readme.html#get-the-right-logger">Get the right logger:</a></li>
Expand Down Expand Up @@ -477,7 +476,7 @@ <h3>Navigation</h3>
<div class="footer">
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Nov 11 2023 at 16:58 (CET).
Last updated on Nov 11 2023 at 16:59 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/license.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ <h3>Navigation</h3>
<div class="footer">
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Nov 11 2023 at 16:58 (CET).
Last updated on Nov 11 2023 at 16:59 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -632,7 +632,7 @@ <h3>Navigation</h3>
<div class="footer">
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Nov 11 2023 at 16:58 (CET).
Last updated on Nov 11 2023 at 16:59 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/py-modindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ <h3>Navigation</h3>
<div class="footer">
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Nov 11 2023 at 16:58 (CET).
Last updated on Nov 11 2023 at 16:59 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
18 changes: 5 additions & 13 deletions docs/readme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,12 @@ <h3><a href="index.html">Table of Contents</a></h3>
<li><a class="reference internal" href="#print-a-snapshot-of-an-order-book">Print a snapshot of an order book</a></li>
<li><a class="reference internal" href="#get-all-symbol-prices">Get all symbol prices</a></li>
<li><a class="reference internal" href="#get-the-used-weight">Get the used weight</a></li>
<li><a class="reference internal" href="#stop-ubra-after-usage-to-avoid-memory-leaks">Stop <code class="docutils literal notranslate"><span class="pre">ubra</span></code> after usage to avoid memory leaks</a></li>
</ul>
</li>
<li><a class="reference internal" href="#send-data-to-binance-rest-api-endpoints">Send data to Binance REST API Endpoints</a><ul>
<li><a class="reference internal" href="#id1">Initiate <code class="docutils literal notranslate"><span class="pre">BinanceRestApiManager()</span></code></a></li>
<li><a class="reference internal" href="#buy-btc-with-a-market-order-using-100-usdt">Buy BTC with a market order using 100 USDT</a></li>
<li><a class="reference internal" href="#id2">Stop <code class="docutils literal notranslate"><span class="pre">ubra</span></code> after usage to avoid memory leaks</a></li>
<li><a class="reference internal" href="#stop-ubra-after-usage-to-avoid-memory-leaks">Stop <code class="docutils literal notranslate"><span class="pre">ubra</span></code> after usage to avoid memory leaks</a></li>
</ul>
</li>
<li><a class="reference internal" href="#get-the-right-logger">Get the right logger:</a></li>
Expand Down Expand Up @@ -295,12 +294,6 @@ <h3>Get the used weight<a class="headerlink" href="#get-the-used-weight" title="
</pre></div>
</div>
</section>
<section id="stop-ubra-after-usage-to-avoid-memory-leaks">
<h3>Stop <code class="docutils literal notranslate"><span class="pre">ubra</span></code> after usage to avoid memory leaks<a class="headerlink" href="#stop-ubra-after-usage-to-avoid-memory-leaks" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ubra</span><span class="o">.</span><span class="n">stop_manager</span><span class="p">()</span>
</pre></div>
</div>
</section>
</section>
<section id="send-data-to-binance-rest-api-endpoints">
<h2>Send data to Binance REST API Endpoints<a class="headerlink" href="#send-data-to-binance-rest-api-endpoints" title="Link to this heading"></a></h2>
Expand All @@ -323,8 +316,8 @@ <h3>Buy BTC with a market order using 100 USDT<a class="headerlink" href="#buy-b
</pre></div>
</div>
</section>
<section id="id2">
<h3>Stop <code class="docutils literal notranslate"><span class="pre">ubra</span></code> after usage to avoid memory leaks<a class="headerlink" href="#id2" title="Link to this heading"></a></h3>
<section id="stop-ubra-after-usage-to-avoid-memory-leaks">
<h3>Stop <code class="docutils literal notranslate"><span class="pre">ubra</span></code> after usage to avoid memory leaks<a class="headerlink" href="#stop-ubra-after-usage-to-avoid-memory-leaks" title="Link to this heading"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ubra</span><span class="o">.</span><span class="n">stop_manager</span><span class="p">()</span>
</pre></div>
</div>
Expand Down Expand Up @@ -644,13 +637,12 @@ <h3><a href="index.html">Table of Contents</a></h3>
<li><a class="reference internal" href="#print-a-snapshot-of-an-order-book">Print a snapshot of an order book</a></li>
<li><a class="reference internal" href="#get-all-symbol-prices">Get all symbol prices</a></li>
<li><a class="reference internal" href="#get-the-used-weight">Get the used weight</a></li>
<li><a class="reference internal" href="#stop-ubra-after-usage-to-avoid-memory-leaks">Stop <code class="docutils literal notranslate"><span class="pre">ubra</span></code> after usage to avoid memory leaks</a></li>
</ul>
</li>
<li><a class="reference internal" href="#send-data-to-binance-rest-api-endpoints">Send data to Binance REST API Endpoints</a><ul>
<li><a class="reference internal" href="#id1">Initiate <code class="docutils literal notranslate"><span class="pre">BinanceRestApiManager()</span></code></a></li>
<li><a class="reference internal" href="#buy-btc-with-a-market-order-using-100-usdt">Buy BTC with a market order using 100 USDT</a></li>
<li><a class="reference internal" href="#id2">Stop <code class="docutils literal notranslate"><span class="pre">ubra</span></code> after usage to avoid memory leaks</a></li>
<li><a class="reference internal" href="#stop-ubra-after-usage-to-avoid-memory-leaks">Stop <code class="docutils literal notranslate"><span class="pre">ubra</span></code> after usage to avoid memory leaks</a></li>
</ul>
</li>
<li><a class="reference internal" href="#get-the-right-logger">Get the right logger:</a></li>
Expand Down Expand Up @@ -798,7 +790,7 @@ <h3>Navigation</h3>
<div class="footer">
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Nov 11 2023 at 16:58 (CET).
Last updated on Nov 11 2023 at 16:59 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ <h3>Navigation</h3>
<div class="footer">
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Nov 11 2023 at 16:58 (CET).
Last updated on Nov 11 2023 at 16:59 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/security.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ <h3>Navigation</h3>
<div class="footer">
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Nov 11 2023 at 16:58 (CET).
Last updated on Nov 11 2023 at 16:59 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/unicorn_binance_rest_api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7789,7 +7789,7 @@ <h3>Navigation</h3>
<div class="footer">
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
See <a href="/license.html">License</a> for more information.<br />
Last updated on Nov 11 2023 at 16:58 (CET).
Last updated on Nov 11 2023 at 16:59 (CET).
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/new/choose">Found a bug</a>?
<br />
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
Expand Down
6 changes: 0 additions & 6 deletions sphinx/source/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,6 @@ https://github.com/binance-us/binance-official-api-docs/blob/master/rest-api.md#
print(f"Used weight: {ubra.get_used_weight()}")
```

### Stop `ubra` after usage to avoid memory leaks

```
ubra.stop_manager()
```

## Send data to Binance REST API Endpoints
### Initiate `BinanceRestApiManager()`

Expand Down

0 comments on commit 3173fc2

Please sign in to comment.