documentation update

Author: jell-o-fishi

docs/conf.py

@@ -71,6 +71,7 @@
 
 autodoc_default_flags = ['members']
 autosummary_generate = True
+autodoc_inherit_docstrings = False
 autodoc_typehints = 'description'
 autodoc_typehints_format = 'short'
 autodoc_member_order = 'bysource'

docs/extensions.rst

@@ -1,9 +1,38 @@
 Extensions
 ==========
 
-.. autosummary::
-   :toctree: generated
+Transports
+----------
 
-.. automodule:: rsocket
-    :noindex:
+TCP
+~~~
 
+.. automodule:: rsocket.transports.tcp
+    :members:
+
+Websocket
+~~~~~~~~~
+
+aiohttp
++++++++
+
+.. automodule:: rsocket.transports.aiohttp_websocket
+    :members:
+
+quart
++++++
+
+.. automodule:: rsocket.transports.quart_websocket
+    :members:
+
+quic
+~~~~
+
+.. automodule:: rsocket.transports.aioquic_transport
+    :members:
+
+http3
+~~~~~
+
+.. automodule:: rsocket.transports.http3_transport
+    :members:

rsocket/transports/aiohttp_websocket.py

@@ -18,6 +18,10 @@
 async def websocket_client(url: Optional[str] = None,
                            websocket: Optional[ClientWebSocketResponse] = None,
                            **kwargs) -> RSocketClient:
+    """
+    Helper method to instantiate an RSocket client using a websocket url over aiohttp client.
+    """
+
     async with RSocketClient(single_transport_provider(TransportAioHttpClient(url, websocket)),
                              **kwargs) as client:
         yield client
@@ -40,6 +44,9 @@ async def websocket_handler(request):
 
 
 class TransportAioHttpClient(AbstractMessagingTransport):
+    """
+    RSocket transport over client side aiohttp websocket.
+    """
 
     def __init__(self, url: Optional[str] = None, websocket: Optional[ClientWebSocketResponse] = None):
         super().__init__()

rsocket/transports/aioquic_transport.py

@@ -80,6 +80,10 @@ def quic_event_received(self, event: QuicEvent) -> None:
 
 
 class RSocketQuicTransport(AbstractMessagingTransport):
+    """
+    RSocket transport over server/client side quic connection.
+    """
+
     def __init__(self, quic_protocol: RSocketQuicProtocol):
         super().__init__()
         self._quic_protocol = quic_protocol

rsocket/transports/http3_transport.py

@@ -43,9 +43,6 @@ async def receive_bytes(self) -> bytes:
         return await self.queue.get()
 
     async def close(self, code: int = 1000, reason: str = "") -> None:
-        """
-        Perform the closing handshake.
-        """
         data = self.websocket.send(
             wsproto.events.CloseConnection(code=code, reason=reason)
         )
@@ -80,6 +77,10 @@ def __init__(self, url: str) -> None:
 
 
 class RSocketHttp3ClientProtocol(QuicConnectionProtocol):
+    """
+    RSocket transport over client side http3 connection.
+    """
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.pushes: Dict[int, Deque[H3Event]] = {}
@@ -149,6 +150,9 @@ def quic_event_received(self, event: QuicEvent) -> None:
 
 
 class Http3TransportWebsocket(AbstractMessagingTransport):
+    """
+    RSocket transport over server side http3 connection.
+    """
 
     def __init__(self, websocket: Union[WebSocket, ClientWebSocket]):
         super().__init__()

rsocket/transports/quart_websocket.py

@@ -10,6 +10,10 @@
 
 
 async def websocket_handler(on_server_create=None, **kwargs):
+    """
+    Helper method to instantiate an RSocket server using a quart websocket connection.
+    """
+
     transport = TransportQuartWebsocket()
     server = RSocketServer(transport, **kwargs)
 
@@ -20,6 +24,9 @@ async def websocket_handler(on_server_create=None, **kwargs):
 
 
 class TransportQuartWebsocket(AbstractMessagingTransport):
+    """
+    RSocket transport over server side quart websocket.
+    """
 
     async def handle_incoming_ws_messages(self):
         try:

rsocket/transports/tcp.py

@@ -6,6 +6,13 @@
 
 
 class TransportTCP(Transport):
+    """
+    RSocket transport over asyncio TCP connection.
+
+    :param reader: asyncio connection reader stream
+    :param writer: asyncio connection writer stream
+    """
+
     def __init__(self, reader: StreamReader, writer: StreamWriter):
         super().__init__()
         self._writer = writer