Add section about debug logging to the docs

README.rst

@@ -43,7 +43,7 @@ Use pip to install it::
 Documentation
 =============
 
-https://picows.readthedocs.io/en/stable/
+https://picows.readthedocs.io/en/latest/
 
 Motivation
 ==========
@@ -152,7 +152,7 @@ Features
 * Provide Cython .pxd for efficient integration of user Cythonized code with picows
 * Ability to check if a frame is the last one in the receiving buffer
 * Auto ping-pong with an option to customize ping/pong messages.
-* Convenient method to measure websocket roundtrip trip time using ping/pong messages.
+* Convenient method to measure websocket roundtrip time using ping/pong messages.
 
 Contributing / Building From Source
 ===================================

docs/source/guides.rst

@@ -230,3 +230,17 @@ If you are using Cython in your project, you can access picows type definitions
 and some extra functionality by importing `picows.pxd <https://raw.githubusercontent.com/tarasko/picows/master/picows/picows.pxd>`_ that is installed with the library.
 
 Check out an `example <https://raw.githubusercontent.com/tarasko/picows/master/examples/echo_client_cython.pyx>`_ of a simple echo client that is written in Cython.
+
+Enable debug logs
+-----------------
+
+**picows** logs using Python's standard logging module under picows.* logger.
+You may use any available way to set log level to PICOWS_DEBUG_LL (=9) to enable
+debug logging.
+
+.. code-block:: python
+    # Either set global log level
+    logging.basicConfig(level=picows.PICOWS_DEBUG_LL)
+    # Or set picows logger log level only
+    logging.basicConfig(level=logging.INFO)
+    logging.getLogger("picows").setLevel(picows.PICOWS_DEBUG_LL)

examples/okx_roundtrip_time.py

@@ -34,5 +34,6 @@ async def main(url):
 
 
 if __name__ == '__main__':
-    logging.basicConfig(level=9)
+    logging.basicConfig(level=logging.INFO)
+    logging.getLogger("picows").setLevel(9)
     asyncio.run(main("wss://ws.okx.com:8443/ws/v5/public"))