Add references in doc (#26)

Author: awarecan

aiohttp_sse_client/client.py

@@ -41,6 +41,19 @@ class MessageEvent:
 class EventSource:
     """Represent EventSource Interface as an async context manager.
 
+    .. code-block:: python
+
+        from aiohttp_sse_client import client as sse_client
+
+        async with sse_client.EventSource(
+            'https://stream.wikimedia.org/v2/stream/recentchange'
+        ) as event_source:
+            try:
+                async for event in event_source:
+                    print(event)
+            except ConnectionError:
+                pass
+
     .. seealso:: https://www.w3.org/TR/eventsource/#eventsource
     """
     def __init__(self, url: str,
@@ -65,6 +78,8 @@ def __init__(self, url: str,
         :param on_open: event handler for open event
         :param on_message: event handler for message event
         :param on_error: event handler for error event
+        :param kwargs: keyword arguments will pass to underlying aiohttp get()
+            method.
         """
         self._url = URL(url)
         if option is not None:

docs/conf.py

@@ -48,7 +48,7 @@
 
 # General information about the project.
 project = u'SSE Client'
-copyright = u"2018-2019, Jason Hu"
+copyright = u"2018-2020, Jason Hu"
 author = u"Jason Hu"
 
 # The version info for the project you're documenting, acts as replacement

docs/index.rst

@@ -8,6 +8,7 @@ Welcome to SSE Client's documentation!
    readme
    installation
    usage
+   references
    modules
    contributing
    authors

docs/references.rst

@@ -0,0 +1,17 @@
+==========
+References
+==========
+
+Class EventSource
+-----------------
+
+.. autoclass:: aiohttp_sse_client.client.EventSource
+    :members:
+
+    .. automethod:: __init__
+
+Class MessageEvent
+------------------
+
+.. autoclass:: aiohttp_sse_client.client.MessageEvent
+    :members: