documentation update

Author: jell-o-fishi

.gitignore

@@ -91,3 +91,4 @@ ENV/
 # PyCharm
 *.iml
 .idea/
+python311/

docs/api.rst

@@ -65,3 +65,43 @@ Transports
 
 .. automodule:: rsocket.transports.transport
     :members:
+
+
+
+
+TCP
+~~~
+
+.. automodule:: rsocket.transports.tcp
+    :members:
+
+
+Quart
+~~~~~
+
+.. automodule:: rsocket.transports.quart_websocket
+    :members:
+
+AIOHttp
+~~~~~~~
+
+.. automodule:: rsocket.transports.aiohttp_websocket
+    :members:
+
+AIOQuic
+~~~~~~~
+
+.. automodule:: rsocket.transports.aioquic_transport
+    :members:
+
+HTTP3
+~~~~~
+
+.. automodule:: rsocket.transports.http3_transport
+    :members:
+
+Websockets
+~~~~~~~~~~
+
+.. automodule:: rsocket.transports.asyncwebsockets_transport
+    :members:

docs/conf.py

@@ -35,7 +35,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     "sphinx.ext.napoleon",
-    "sphinx.ext.viewcode"
+    "sphinx.ext.viewcode",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

rsocket/request_handler.py

@@ -33,7 +33,8 @@ async def request_channel(self,
                               ) -> Tuple[Optional[Publisher], Optional[Subscriber]]:
         """
         Bi-Directional communication.  A publisher on each end is connected
-        to a subscriber on the other end.
+        to a subscriber on the other end. Note that the first payload sent to the handler is passed as
+        an argument to this method and not to the local subscriber.
         """
 
     @abstractmethod

rsocket/rsocket_client.py

@@ -24,6 +24,7 @@ class RSocketClient(RSocketBase):
     :param transport_provider: Async generator which returns `Transport` to use with this instance.
     :param request_queue_size: Number of frames which can be queued while waiting for a lease.
     :param fragment_size_bytes: Minimum 64, Maximum depends on transport.
+    :param handler_factory: Callable which returns the implemented application logic endpoints. See also :class:`RequestRouter <rsocket.routing.request_router.RequestRouter>`
     """
 
     def __init__(self,

rsocket/rsocket_server.py

@@ -15,10 +15,11 @@ class RSocketServer(RSocketBase):
     """
     Server side instance of an RSocket connection.
 
-    :param transport: Transport to use with this instance. See `Transport` class implementations.
+    :param transport: Transport to use with this instance. See :class:`Transport <rsocket.transports.transport.Transport>` class implementations.
     :param request_queue_size: Number of frames which can be queued while waiting for a lease.
     :param fragment_size_bytes: Minimum 64, Maximum depends on transport.
     :param on_ready: Called after the RSocket server internals setup is done.
+    :param handler_factory: Callable which returns the implemented application logic endpoints. See also :class:`RequestRouter <rsocket.routing.request_router.RequestRouter>`
     """
 
     def __init__(self,

rsocket/transports/aioquic_transport.py

@@ -57,6 +57,9 @@ def protocol_factory(*protocol_args, **protocol_kwargs):
 
 
 class RSocketQuicProtocol(QuicConnectionProtocol):
+    """
+    RSocket transport over server side quic.
+    """
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.frame_queue = asyncio.Queue()

rsocket/transports/quart_websocket.py

@@ -25,7 +25,7 @@ async def websocket_handler(on_server_create=None, **kwargs):
 
 class TransportQuartWebsocket(AbstractMessagingTransport):
     """
-    RSocket transport over server side quart websocket.
+    RSocket transport over server side quart websocket. Use the :method:`websocket_handler <rsocket.transports.quart_websocket.websocket_handler>` helper method to instantiate.
     """
 
     async def handle_incoming_ws_messages(self):

rsocket/transports/transport.py

@@ -6,7 +6,14 @@
 
 class Transport(metaclass=abc.ABCMeta):
     """
-    Base class for all transports.
+    Base class for all transports:
+
+    - tcp: :class:`TransportTCP <rsocket.transports.tcp.TransportTCP>`
+    - websocket: :class:`TransportAsyncWebsocketsClient <rsocket.transports.asyncwebsockets_transport.TransportAsyncWebsocketsClient>`
+    - http3: :class:`Http3TransportWebsocket <rsocket.transports.http3_transport.Http3TransportWebsocket>`
+    - aioquic: :class:`RSocketQuicProtocol <rsocket.transports.aioquic_transport.RSocketQuicProtocol>`
+    - aiohttp: :class:`TransportAioHttpWebsocket <rsocket.transports.aiohttp_websocket.TransportAioHttpWebsocket>`
+    - quart: :class:`TransportQuartWebsocket <rsocket.transports.quart_websocket.TransportQuartWebsocket>`
     """
 
     def __init__(self):