Update requirements (sphinx>=2), and polish documents (#180)

* polish docstring

* update dependency: sphinx>=2

* fix lint err

Author: okue

docs/source/linebot.models.rst

@@ -2,9 +2,10 @@ linebot.models package
 ======================
 
 linebot.models.actions module
---------------------------
+------------------------------
 
 .. automodule:: linebot.models.actions
+    :exclude-members: get_action, get_actions
 
 linebot.models.base module
 --------------------------
@@ -59,4 +60,4 @@ linebot.models.template module
 linebot.models.things module
 ------------------------------
 
-.. automodule:: linebot.models.things
+.. automodule:: linebot.models.things

linebot/api.py

@@ -206,7 +206,7 @@ def get_message_delivery_broadcast(self, date, timeout=None):
 
         Gets the number of messages sent with the /bot/message/broadcast endpoint.
 
-        :param str date: Date the messages were sent. The format is `yyyyMMdd`(Timezone is UTC+9).
+        :param str date: Date the messages were sent. The format is `yyyyMMdd` (Timezone is UTC+9).
         :param timeout: (optional) How long to wait for the server
             to send data before giving up, as a float,
             or a (connect timeout, read timeout) float tuple.

linebot/exceptions.py

@@ -32,17 +32,13 @@ def __init__(self, message='-'):
         self.message = message
 
     def __repr__(self):
-        """repr.
-
-        :return:
-        """
+        """repr."""
         return str(self)
 
     def __str__(self):
         """str.
 
         :rtype: str
-        :return:
         """
         return '<{0} [{1}]>'.format(
             self.__class__.__name__, self.message)
@@ -78,7 +74,6 @@ def __str__(self):
         """str.
 
         :rtype: str
-        :return:
         """
         return '{0}: status_code={1}, error_response={2}'.format(
             self.__class__.__name__, self.status_code, self.error)

linebot/models/base.py

@@ -35,40 +35,31 @@ def __init__(self, **kwargs):
         pass
 
     def __str__(self):
-        """__str__ method.
-
-        :return:
-        """
+        """__str__ method."""
         return self.as_json_string()
 
     def __repr__(self):
-        """__repr__ method.
-
-        :return:
-        """
+        """__repr__ method."""
         return str(self)
 
     def __eq__(self, other):
         """__eq__ method.
 
         :param other:
-        :return:
         """
         return other and self.as_json_dict() == other.as_json_dict()
 
     def __ne__(self, other):
         """__ne__ method.
 
         :param other:
-        :return:
         """
         return not self.__eq__(other)
 
     def as_json_string(self):
         """Return JSON string from this object.
 
         :rtype: str
-        :return:
         """
         return json.dumps(self.as_json_dict(), sort_keys=True)
 
@@ -100,8 +91,6 @@ def new_from_json_dict(cls, data):
         """Create a new instance from a dict.
 
         :param data: JSON dict
-        :rtype:
-        :return:
         """
         new_data = {utils.to_snake_case(key): value
                     for key, value in data.items()}
@@ -119,7 +108,6 @@ def get_or_new_from_json_dict(data, cls):
         :param data:
         :param cls:
         :rtype: object
-        :return:
         """
         if isinstance(data, cls):
             return data
@@ -142,7 +130,6 @@ def get_or_new_from_json_dict_with_types(
         :param cls_map:
         :param type_key:
         :rtype: object
-        :return:
         """
         if isinstance(data, tuple(cls_map.values())):
             return data

linebot/models/error.py

@@ -31,7 +31,6 @@ def __init__(self, message=None, details=None, **kwargs):
         :param str message: Summary of the error
         :param details: ErrorDetail instance list
         :type details: list[T <= :py:class:`linebot.models.error.ErrorDetail`]
-        :type
         :param kwargs:
         """
         super(Error, self).__init__(**kwargs)

linebot/models/events.py

@@ -443,7 +443,6 @@ def device_message(self):
         """Get dm(device_message) as bytearray.
 
         :rtype: bytearray
-        :return:
         """
         return bytearray.fromhex(self.dm) if self.dm is not None else None
 

linebot/models/responses.py

@@ -106,7 +106,6 @@ def iter_content(self, chunk_size=1024):
 
         :param chunk_size: Chunk size
         :rtype: iterator
-        :return:
         """
         return self.response.iter_content(chunk_size=chunk_size)
 

linebot/models/sources.py

@@ -46,7 +46,6 @@ def sender_id(self):
         'sender_id' is deprecated.
 
         :rtype: str
-        :return:
         """
         warnings.warn("'sender_id' is deprecated.", DeprecationWarning, stacklevel=2)
         raise NotImplementedError
@@ -78,7 +77,6 @@ def sender_id(self):
         'sender_id' is deprecated. Use 'user_id' instead.
 
         :rtype: str
-        :return:
         """
         warnings.warn("'sender_id' is deprecated.", DeprecationWarning, stacklevel=2)
         return self.user_id
@@ -112,7 +110,6 @@ def sender_id(self):
         'sender_id' is deprecated. Use 'group_id' instead.
 
         :rtype: str
-        :return:
         """
         warnings.warn("'sender_id' is deprecated.", DeprecationWarning, stacklevel=2)
         return self.group_id
@@ -146,7 +143,6 @@ def sender_id(self):
         'sender_id' is deprecated. Use 'room_id' instead.
 
         :rtype: str
-        :return:
         """
         warnings.warn("'sender_id' is deprecated.", DeprecationWarning, stacklevel=2)
         return self.room_id

linebot/utils.py

@@ -30,7 +30,6 @@ def to_snake_case(text):
 
     :param str text:
     :rtype: str
-    :return:
     """
     s1 = re.sub('(.)([A-Z][a-z]+)', r'\1_\2', text)
     return re.sub('([a-z0-9])([A-Z])', r'\1_\2', s1).lower()
@@ -41,7 +40,6 @@ def to_camel_case(text):
 
     :param str text:
     :rtype: str
-    :return:
     """
     split = text.split('_')
     return split[0] + "".join(x.title() for x in split[1:])

requirements-dev.txt

@@ -2,6 +2,7 @@
 -r requirements-test.txt
 tox
 wheel
+sphinx>=2
 sphinx_rtd_theme
 pypandoc
 twine