Skip to content

Commit ca3fb55

Browse files
oliver-zehentleitneroliver-zehentleitner
committed
2.6.0 docs
1 parent a78519d commit ca3fb55

24 files changed

+525
-236
lines changed

‎dev/sphinx/create_docs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
# Copyright (c) 2019-2024, LUCIT Systems and Development (https://www.lucit.tech)
1919
# All rights reserved.
2020

21-
set -xeuo pipefail
21+
# set -xeuo pipefail
2222

2323
rm dev/sphinx/source/changelog.md
2424
rm dev/sphinx/source/code_of_conduct.md

‎dev/sphinx/source/changelog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
1515
### Added
1616
- Better Logging to investigate [issue#374](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/374)
1717
- `send_with_stream()` - Send a payload with a specific stream.
18+
- Since UBWA is delivered as a compiled C extension, IDEs such as Pycharm and Visual Code cannot use information about
19+
available methods, parameters and their types for autocomplete and other intellisense functions. As a solution, from
20+
now on stub files (PYI) will be created in the build process and attached to the packages. The IDEs can automatically
21+
obtain the required information from these.
1822
### Changed
1923
- Replaced all calls of `add_payload_to_stream()` in `manager.py`, `api.py` with `send_with_stream()`
2024
- Calling `set_socket_is_not_ready()` in `sockets.__aexit__()`
25+
- Consistent use of `stream_list_lock` and replacement of `stream_threading_lock` by `stream_list_lock` in `manager.py`.
2126

2227
## 2.5.0
2328
Functionally, nothing changes with this update. However, there are now sensible error messages if errors occur in the

‎docs/_modules/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ <h3>Navigation</h3>
254254
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
255255
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
256256
See <a href="/license.html">License</a> for more information.<br />
257-
Last updated on May 07 2024 at 10:19 (CET).
257+
Last updated on May 08 2024 at 14:54 (CET).
258258
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
259259
<br />
260260
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/_modules/unicorn_binance_websocket_api/api.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2258,7 +2258,7 @@ <h3>Navigation</h3>
22582258
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
22592259
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
22602260
See <a href="/license.html">License</a> for more information.<br />
2261-
Last updated on May 06 2024 at 20:40 (CET).
2261+
Last updated on May 08 2024 at 14:54 (CET).
22622262
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
22632263
<br />
22642264
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/_modules/unicorn_binance_websocket_api/connection.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>unicorn_binance_websocket_api.connection &#8212; unicorn-binance-websocket-api 2.3.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<title>unicorn_binance_websocket_api.connection &#8212; unicorn-binance-websocket-api 2.6.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
88

99
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=92fd9be5" />
1010
<link rel="stylesheet" type="text/css" href="../../_static/pydoctheme.css?v=fdf8e9ae" />
@@ -464,7 +464,7 @@ <h3>Navigation</h3>
464464
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
465465
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
466466
See <a href="/license.html">License</a> for more information.<br />
467-
Last updated on Apr 01 2024 at 23:53 (CET).
467+
Last updated on May 08 2024 at 14:54 (CET).
468468
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
469469
<br />
470470
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

‎docs/_modules/unicorn_binance_websocket_api/exceptions.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>unicorn_binance_websocket_api.exceptions &#8212; unicorn-binance-websocket-api 2.3.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<title>unicorn_binance_websocket_api.exceptions &#8212; unicorn-binance-websocket-api 2.6.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
88

99
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=92fd9be5" />
1010
<link rel="stylesheet" type="text/css" href="../../_static/pydoctheme.css?v=fdf8e9ae" />
@@ -324,7 +324,7 @@ <h3>Navigation</h3>
324324
<a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
325325
&copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
326326
See <a href="/license.html">License</a> for more information.<br />
327-
Last updated on Mar 27 2024 at 23:34 (CET).
327+
Last updated on May 08 2024 at 14:54 (CET).
328328
<a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-websocket-api/issues/new/choose">Found a bug</a>?
329329
<br />
330330
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

0 commit comments

Comments
 (0)