Sphinx markup fixes

Author: vshlapakov

docs/client/apidocs.rst

@@ -9,7 +9,6 @@ Client object
     :undoc-members:
     :inherited-members:
 
-
 Activity
 --------
 
@@ -32,7 +31,6 @@ Exceptions
 .. automodule:: scrapinghub.client.exceptions
     :members:
     :undoc-members:
-    :inherited-members:
 
 Frontiers
 ---------
@@ -97,11 +95,3 @@ Spiders
     :members:
     :undoc-members:
     :inherited-members:
-
-Utils
------
-
-.. automodule:: scrapinghub.client.utils
-    :members:
-    :undoc-members:
-    :inherited-members:

scrapinghub/client/__init__.py

@@ -31,10 +31,10 @@ class ScrapinghubClient(object):
     :param auth: Scrapinghub APIKEY or other SH auth credentials.
     :param dash_endpoint: (optional) Scrapinghub Dash panel url.
     :param \*\*kwargs: (optional) Additional arguments for
-        :class:`scrapinghub.hubstorage.HubstorageClient` constructor.
+        :class:`~scrapinghub.hubstorage.HubstorageClient` constructor.
 
     :ivar projects: projects collection,
-        :class:`scrapinghub.client.projects.Projects` instance.
+        :class:`~scrapinghub.client.projects.Projects` instance.
 
     Usage::
 
@@ -60,7 +60,7 @@ def get_project(self, project_id):
 
         :param project_id: integer or string numeric project id.
         :return: a project instance.
-        :rtype: :class:`scrapinghub.client.projects.Project`
+        :rtype: :class:`~scrapinghub.client.projects.Project`
 
         Usage::
 
@@ -76,7 +76,7 @@ def get_job(self, job_key):
         :param job_key: job key string in format 'project_id/spider_id/job_id',
             where all the components are integers.
         :return: a job instance.
-        :rtype: :class:`scrapinghub.client.jobs.Job`
+        :rtype: :class:`~scrapinghub.client.jobs.Job`
 
         Usage::
 

scrapinghub/client/activity.py

@@ -7,11 +7,12 @@
 class Activity(_Proxy):
     """Representation of collection of job activity events.
 
-    Not a public constructor: use :class:`Project` instance to get a
-    :class:`Activity` instance. See :attr:`Project.activity` attribute.
+    Not a public constructor: use :class:`~scrapinghub.client.projects.Project`
+    instance to get a :class:`~scrapinghub.client.activity.Activity` instance.
+    See :attr:`~scrapinghub.client.projects.Project.activity` attribute.
 
-    Please note that list() method can use a lot of memory and for a large
-    amount of activities it's recommended to iterate through it via iter()
+    Please note that ``list()`` method can use a lot of memory and for a large
+    amount of activities it's recommended to iterate through it via ``iter()``
     method (all params and available filters are same for both methods).
 
     Usage:

scrapinghub/client/collections.py

@@ -13,8 +13,9 @@
 class Collections(_Proxy):
     """Access to project collections.
 
-    Not a public constructor: use :class:`Project` instance to get a
-    :class:`Collections` instance. See :attr:`Project.collections` attribute.
+    Not a public constructor: use :class:`~scrapinghub.client.projects.Project`
+    instance to get a :class:`Collections` instance.
+    See :attr:`~scrapinghub.client.projects.Project.collections` attribute.
 
     Usage::
 
@@ -29,7 +30,7 @@ def get(self, type_, name):
 
         :param type_: a collection type string.
         :param name: a collection name string.
-        :return: :class:`Collection` object.
+        :return: a collection object.
         :rtype: :class:`Collection`
         """
         self._origin._validate_collection(type_, name)
@@ -39,7 +40,7 @@ def get_store(self, name):
         """Method to get a store collection by name.
 
         :param name: a collection name string.
-        :return: :class:`Collection` object.
+        :return: a collection object.
         :rtype: :class:`Collection`
         """
         return self.get('s', name)
@@ -50,7 +51,7 @@ def get_cached_store(self, name):
         The collection type means that items expire after a month.
 
         :param name: a collection name string.
-        :return: :class:`Collection` object.
+        :return: a collection object.
         :rtype: :class:`Collection`
         """
         return self.get('cs', name)
@@ -61,7 +62,7 @@ def get_versioned_store(self, name):
         The collection type retains up to 3 copies of each item.
 
         :param name: a collection name string.
-        :return: :class:`Collection` object.
+        :return: a collection object.
         :rtype: :class:`Collection`
         """
         return self.get('vs', name)
@@ -72,7 +73,7 @@ def get_versioned_cached_store(self, name):
         Multiple copies are retained, and each one expires after a month.
 
         :param name: a collection name string.
-        :return: :class:`Collection` object.
+        :return: a collection object.
         :rtype: :class:`Collection`
         """
         return self.get('vcs', name)
@@ -159,9 +160,10 @@ def list(self, key=None, prefix=None, prefixcount=None, startts=None,
              endts=None, requests_params=None, **params):
         """Convenient shortcut to list iter results.
 
-        Please note that list() method can use a lot of memory and for a large
-        amount of elements it's recommended to iterate through it via iter()
-        method (all params and available filters are same for both methods).
+        Please note that ``list()`` method can use a lot of memory and for a
+        large amount of elements it's recommended to iterate through it via
+        ``iter()`` method (all params and available filters are same for both
+        methods).
 
         :param key: a string key or a list of keys to filter with.
         :param prefix: a string prefix to filter items.
@@ -197,7 +199,7 @@ def set(self, value):
 
         :param value: a dict representing a collection item.
 
-        The method returns None (original method returns an empty generator).
+        The method returns ``None`` (original method returns an empty generator).
         """
         self._origin.set(value)
 
@@ -206,7 +208,7 @@ def delete(self, keys):
 
         :param keys: a single key or a list of keys.
 
-        The method returns None (original method returns an empty generator).
+        The method returns ``None`` (original method returns an empty generator).
         """
         if (not isinstance(keys, string_types) and
                 not isinstance(keys, collections.Iterable)):

scrapinghub/client/frontiers.py

@@ -22,7 +22,7 @@ def _get_writer(self, frontier, slot):
         callback to write newcount data per slot.
 
         :return: a batchuploader writer instance.
-        :rtype: :class:`scrapinghub.hubstorage.batchuploader._BatchWriter`
+        :rtype: :class:`~scrapinghub.hubstorage.batchuploader._BatchWriter`
         """
         key = (frontier, slot)
         writer = self._writers.get(key)
@@ -48,8 +48,9 @@ def _writer_callback(self, key, response):
 class Frontiers(_Proxy):
     """Frontiers collection for a project.
 
-    Not a public constructor: use :class:`Project` instance to get a
-    :class:`Frontiers` instance. See :attr:`Project.frontiers` attribute.
+    Not a public constructor: use :class:`~scrapinghub.client.projects.Project`
+    instance to get a :class:`Frontiers` instance.
+    See :attr:`~scrapinghub.client.Project.frontiers` attribute.
 
     Usage:
 
@@ -89,7 +90,7 @@ def get(self, name):
         """Get a frontier by name.
 
         :param name: a frontier name string.
-        :return: :class:`Frontier` instance.
+        :return: a frontier instance.
         :rtype: :class:`Frontier`
         """
         return Frontier(self._client, self, name)
@@ -160,7 +161,7 @@ def __init__(self, client, frontiers, name):
     def get(self, slot):
         """Get a slot by name.
 
-        :return: :class:`FrontierSlot` instance.
+        :return: a frontier slot instance.
         :rtype: :class:`FrontierSlot`
         """
         return FrontierSlot(self._client, self, slot)
@@ -260,7 +261,7 @@ def __init__(self, client, frontier, slot):
     def f(self):
         """Shortcut to have quick access to slot fingerprints.
 
-        :return: :class:`FrontierSlotFingerprints` instance.
+        :return: fingerprints collection for the slot.
         :rtype: :class:`FrontierSlotFingerprints`
         """
         return self.fingerprints
@@ -269,7 +270,7 @@ def f(self):
     def q(self):
         """Shortcut to have quick access to a slot queue.
 
-        :return: :class:`FrontierSlotQueue` instance.
+        :return: queue instance for the slot.
         :rtype: :class:`FrontierSlotQueue`
         """
         return self.queue

scrapinghub/client/items.py

@@ -6,11 +6,12 @@
 class Items(_Proxy):
     """Representation of collection of job items.
 
-    Not a public constructor: use :class:`Job` instance to get a :class:`Items`
-    instance. See :attr:`Job.items` attribute.
+    Not a public constructor: use :class:`~scrapinghub.client.jobs.Job` instanc
+    e to get a :class:`Items` instance.
+    See :attr:`~scrapinghub.client.jobs.Job.items` attribute.
 
-    Please note that list() method can use a lot of memory and for a large
-    amount of items it's recommended to iterate through it via iter() method
+    Please note that ``list()`` method can use a lot of memory and for a large
+    amount of items it's recommended to iterate through it via ``iter()`` method
     (all params and available filters are same for both methods).
 
     Usage:

scrapinghub/client/jobs.py

@@ -19,9 +19,10 @@
 class Jobs(object):
     """Class representing a collection of jobs for a project/spider.
 
-    Not a public constructor: use :class:`Project` instance or :class:`Spider`
-    instance to get a :class:`Jobs` instance. See :attr:`Project.jobs` and
-    :attr:`Spider.jobs` attributes.
+    Not a public constructor: use :class:`~scrapinghub.client.projects.Project`
+    instance or :class:`~scrapinghub.client.spiders.Spider` instance to get
+    a :class:`Jobs` instance. See :attr:`scrapinghub.client.projects.Project.jobs`
+    and :attr:`scrapinghub.client.spiders.Spider.jobs` attributes.
 
     :ivar project_id: a string project id.
     :ivar spider: :class:`Spider` object if defined.
@@ -235,7 +236,7 @@ def get(self, job_key):
         :class:`Jobs` instance, and job_key's spider component should match
         the spider (if :attr:`Spider.jobs` was used).
 
-        :return: :class:`Job` object.
+        :return: a job object.
         :rtype: :class:`Job`
 
         Usage::
@@ -255,8 +256,8 @@ def summary(self, state=None, spider=None, **params):
         """Get jobs summary (optionally by state).
 
         :param state: (optional) a string state to filter jobs.
-        :param spider: (optional) a spider name
-            (not needed if instantiated with :class:`Spider`).
+        :param spider: (optional) a spider name (not needed if instantiated
+            with :class:`~scrapinghub.client.spiders.Spider`).
         :param \*\*params: (optional) additional keyword args.
         :return: a list of dictionaries of jobs summary
             for a given filter params grouped by job state.
@@ -283,8 +284,8 @@ def iter_last(self, start=None, start_after=None, count=None,
         :param start: (optional)
         :param start_after: (optional)
         :param count: (optional)
-        :param spider: (optional) a spider name
-            (not needed if instantiated with :class:`Spider`).
+        :param spider: (optional) a spider name (not needed if instantiated
+            with :class:`~scrapinghub.client.spiders.Spider`).
         :param \*\*params: (optional) additional keyword args.
         :return: a generator object over a list of dictionaries of jobs summary
             for a given filter params.
@@ -371,17 +372,18 @@ def update_tags(self, add=None, remove=None, spider=None):
 class Job(object):
     """Class representing a job object.
 
-    Not a public constructor: use :class:`ScrapinghubClient` instance or
-    :class:`Jobs` instance to get a :class:`Job` instance. See
-    :meth:`ScrapinghubClient.get_job` and :meth:`Jobs.get` methods.
+    Not a public constructor: use :class:`~scrapinghub.client.ScrapinghubClient`
+    instance or :class:`Jobs` instance to get a :class:`Job` instance. See
+    :meth:`scrapinghub.client.ScrapinghubClient.get_job` and :meth:`Jobs.get`
+    methods.
 
     :ivar project_id: integer project id.
     :ivar key: a job key.
-    :ivar items: :class:`Items` resource object.
-    :ivar logs: :class:`Logs` resource object.
-    :ivar requests: :class:`Requests` resource object.
-    :ivar samples: :class:`Samples` resource object.
-    :ivar metadata: :class:`Metadata` resource.
+    :ivar items: :class:`~scrapinghub.client.items.Items` resource object.
+    :ivar logs: :class:`~scrapinghub.client.logs.Logs` resource object.
+    :ivar requests: :class:`~scrapinghub.client.requests.Requests` resource object.
+    :ivar samples: :class:`~scrapinghub.client.samples.Samples` resource object.
+    :ivar metadata: :class:`JobMeta` resource object.
 
     Usage::
 
@@ -508,7 +510,7 @@ class JobMeta(_MappingProxy):
     """Class representing job metadata.
 
     Not a public constructor: use :class:`Job` instance to get a
-    :class:`Jobmeta` instance. See :attr:`Job.metadata` attribute.
+    :class:`JobMeta` instance. See :attr:`Job.metadata` attribute.
 
     Usage:
 

scrapinghub/client/logs.py

@@ -8,11 +8,12 @@
 class Logs(_Proxy):
     """Representation of collection of job logs.
 
-    Not a public constructor: use :class:`Job` instance to get a :class:`Logs`
-    instance. See :attr:`Job.logs` attribute.
+    Not a public constructor: use :class:`~scrapinghub.client.jobs.Job` instance
+    to get a :class:`Logs` instance. See :attr:`~scrapinghub.client.jobs.Job.logs`
+    attribute.
 
-    Please note that list() method can use a lot of memory and for a large
-    amount of logs it's recommended to iterate through it via iter() method
+    Please note that ``list()`` method can use a lot of memory and for a large
+    amount of logs it's recommended to iterate through it via ``iter()`` method
     (all params and available filters are same for both methods).
 
     Usage:

scrapinghub/client/projects.py

@@ -15,8 +15,9 @@
 class Projects(object):
     """Collection of projects available to current user.
 
-    Not a public constructor: use :class:`ScrapinghubClient` client instance to get
-    a :class:`Projects` instance. See :attr:`Scrapinghub.projects` attribute.
+    Not a public constructor: use :class:`~scrapinghub.client.ScrapinghubClient`
+    client instance to get a :class:`Projects` instance.
+    See :attr:`scrapinghub.client.Scrapinghub.projects` attribute.
 
     Usage::
 
@@ -31,8 +32,8 @@ def get(self, project_id):
         """Get project for a given project id.
 
         :param project_id: integer or string numeric project id.
-        :return: :class:`Project` object.
-        :rtype: :class:`scrapinghub.client.projects.Project`
+        :return: a project object.
+        :rtype: :class:`Project`
 
         Usage::
 
@@ -96,17 +97,18 @@ def summary(self, state=None, **params):
 class Project(object):
     """Class representing a project object and its resources.
 
-    Not a public constructor: use :class:`ScrapinghubClient` instance or
-    :class:`Projects` instance to get a :class:`Project` instance. See
-    :meth:`ScrapinghubClient.get_project` or :meth:`Projects.get` methods.
+    Not a public constructor: use :class:`~scrapinghub.client.ScrapinghubClient`
+    instance or :class:`Projects` instance to get a :class:`Project` instance.
+    See :meth:`scrapinghub.client.ScrapinghubClient.get_project` or
+    :meth:`Projects.get` methods.
 
     :ivar key: string project id.
-    :ivar activity: :class:`Activity` resource object.
-    :ivar collections: :class:`Collections` resource object.
-    :ivar frontiers: :class:`Frontiers` resource object.
-    :ivar jobs: :class:`Jobs` resource object.
-    :ivar settings: :class:`Settings` resource object.
-    :ivar spiders: :class:`Spiders` resource object.
+    :ivar activity: :class:`~scrapinghub.client.activity.Activity` resource object.
+    :ivar collections: :class:`~scrapinghub.client.collections.Collections` resource object.
+    :ivar frontiers: :class:`~scrapinghub.client.frontiers.Frontiers` resource object.
+    :ivar jobs: :class:`~scrapinghub.client.jobs.Jobs` resource object.
+    :ivar settings: :class:`~scrapinghub.client.settings.Settings` resource object.
+    :ivar spiders: :class:`~scrapinghub.client.spiders.Spiders` resource object.
 
     Usage::