Use autoexception in docs

Author: vshlapakov

docs/client/overview.rst

@@ -573,46 +573,13 @@ Modifying tags is available on spider/job levels.
 Exceptions
 ----------
 
-scrapinghub.exceptions.ScrapinghubAPIError
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Base exception class for all other exceptions listed below.
-
-
-scrapinghub.exceptions.BadRequest
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Usually raised in case of 400 response from API.
-
-
-scrapinghub.exceptions.Unauthorized
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Not enough access to some resources.
-
-
-scrapinghub.exceptions.NotFound
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Entity doesn't exist (e.g. spider or project).
-
-
-scrapinghub.exceptions.ValueTooLarge
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Value cannot be writtent because it exceeds size limits.
-
-
-scrapinghub.exceptions.DuplicateJobError
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Job for given spider with given arguments is already scheduled or running.
-
-
-scrapinghub.exceptions.ServerError
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Indicates some server error: something unexpected has happened.
+.. autoexception:: scrapinghub.ScrapinghubAPIError
+.. autoexception:: scrapinghub.BadRequest
+.. autoexception:: scrapinghub.Unauthorized
+.. autoexception:: scrapinghub.NotFound
+.. autoexception:: scrapinghub.ValueTooLarge
+.. autoexception:: scrapinghub.DuplicateJobError
+.. autoexception:: scrapinghub.ServerError
 
 
 .. _Scrapinghub API: http://doc.scrapinghub.com/api.html

scrapinghub/__init__.py

@@ -1,7 +1,7 @@
 __all__ = ["APIError", "Connection", "HubstorageClient",
            "ScrapinghubClient", "ScrapinghubAPIError",
            "DuplicateJobError", "BadRequest", "NotFound",
-           "Unauthorized", "ValueTooLarge"]
+           "Unauthorized", "ValueTooLarge", "ServerError"]
 
 import pkgutil
 __version__ = pkgutil.get_data(__package__, 'VERSION')
@@ -19,4 +19,5 @@
     NotFound,
     Unauthorized,
     ValueTooLarge,
+    ServerError,
 )

scrapinghub/client/exceptions.py

@@ -24,6 +24,7 @@ def _get_http_error_msg(exc):
 
 
 class ScrapinghubAPIError(Exception):
+    """Base exception class."""
 
     def __init__(self, message=None, http_error=None):
         self.http_error = http_error
@@ -33,27 +34,27 @@ def __init__(self, message=None, http_error=None):
 
 
 class BadRequest(ScrapinghubAPIError):
-    pass
+    """Usually raised in case of 400 response from API."""
 
 
 class Unauthorized(ScrapinghubAPIError):
-    pass
+    """Request lacks valid authentication credentials for the target resource."""
 
 
 class NotFound(ScrapinghubAPIError):
-    pass
+    """Entity doesn't exist (e.g. spider or project)."""
 
 
 class ValueTooLarge(ScrapinghubAPIError):
-    pass
+    """Value cannot be writtent because it exceeds size limits."""
 
 
 class DuplicateJobError(ScrapinghubAPIError):
-    pass
+    """Job for given spider with given arguments is already scheduled or running."""
 
 
 class ServerError(ScrapinghubAPIError):
-    pass
+    """Indicates some server error: something unexpected has happened."""
 
 
 def wrap_http_errors(method):