Minor docstrings fixes, plain apidocs struct

Author: vshlapakov

docs/client/apidocs.rst

@@ -1,110 +1,107 @@
 API Reference
 =============
 
-Module contents
----------------
+Client object
+-------------
 
 .. automodule:: scrapinghub.client
     :members:
     :undoc-members:
-    :show-inheritance:
+    :inherited-members:
 
 
-Submodules
-----------
-
-activity
+Activity
 --------
 
 .. automodule:: scrapinghub.client.activity
     :members:
     :undoc-members:
-    :show-inheritance:
+    :inherited-members:
 
-collections
+Collections
 -----------
 
 .. automodule:: scrapinghub.client.collections
     :members:
     :undoc-members:
-    :show-inheritance:
+    :inherited-members:
 
-exceptions
+Exceptions
 ----------
 
 .. automodule:: scrapinghub.client.exceptions
     :members:
     :undoc-members:
-    :show-inheritance:
+    :inherited-members:
 
-frontiers
+Frontiers
 ---------
 
 .. automodule:: scrapinghub.client.frontiers
     :members:
     :undoc-members:
-    :show-inheritance:
+    :inherited-members:
 
-items
+Items
 -----
 
 .. automodule:: scrapinghub.client.items
     :members:
     :undoc-members:
-    :show-inheritance:
+    :inherited-members:
 
-jobs
+Jobs
 ----
 
 .. automodule:: scrapinghub.client.jobs
     :members:
     :undoc-members:
-    :show-inheritance:
+    :inherited-members:
 
-logs
+Logs
 ----
 
 .. automodule:: scrapinghub.client.logs
     :members:
     :undoc-members:
-    :show-inheritance:
+    :inherited-members:
 
-projects
+Projects
 --------
 
 .. automodule:: scrapinghub.client.projects
     :members:
     :undoc-members:
-    :show-inheritance:
+    :inherited-members:
 
-requests
+Requests
 --------
 
 .. automodule:: scrapinghub.client.requests
     :members:
     :undoc-members:
-    :show-inheritance:
+    :inherited-members:
 
-samples
+Samples
 -------
 
 .. automodule:: scrapinghub.client.samples
     :members:
     :undoc-members:
-    :show-inheritance:
+    :inherited-members:
 
-spiders
+Spiders
 -------
 
 .. automodule:: scrapinghub.client.spiders
     :members:
     :undoc-members:
-    :show-inheritance:
+    :inherited-members:
 
-utils
+Utils
 -----
 
 .. automodule:: scrapinghub.client.utils
     :members:
     :undoc-members:
-    :show-inheritance:
+    :inherited-members:

docs/client/overview.rst

@@ -51,7 +51,7 @@ Project
 
 Project instance has ``jobs`` field to work with the project jobs.
 
-Jobs instance is described well in ``Jobs`` section below.
+Jobs instance is described well in :ref:`Jobs <jobs>` section below.
 
 For example, to schedule a spider run (it returns a job object)::
 

scrapinghub/client/__init__.py

@@ -33,7 +33,8 @@ class ScrapinghubClient(object):
     :param \*\*kwargs: (optional) Additional arguments for
         :class:`scrapinghub.hubstorage.HubstorageClient` constructor.
 
-    :ivar projects: projects collection, :class:`Projects` instance.
+    :ivar projects: projects collection,
+        :class:`scrapinghub.client.projects.Projects` instance.
 
     Usage::
 
@@ -52,12 +53,13 @@ def __init__(self, auth=None, dash_endpoint=None, **kwargs):
         self._hsclient = HubstorageClient(auth=(login, password), **kwargs)
 
     def get_project(self, project_id):
-        """Get :class:`Project` instance with a given project id.
+        """Get :class:`scrapinghub.client.projects.Project` instance with
+        a given project id.
 
         The method is a shortcut for client.projects.get().
 
         :param project_id: integer or string numeric project id.
-        :return: :class:`Project` object.
+        :return: a project instance.
         :rtype: :class:`scrapinghub.client.projects.Project`
 
         Usage::
@@ -73,7 +75,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: :class:`Job` object.
+        :return: a job instance.
         :rtype: :class:`scrapinghub.client.jobs.Job`
 
         Usage::

scrapinghub/client/projects.py

@@ -15,7 +15,7 @@
 class Projects(object):
     """Collection of projects available to current user.
 
-    Not a public constructor: use :class:`Scrapinghub` client instance to get
+    Not a public constructor: use :class:`ScrapinghubClient` client instance to get
     a :class:`Projects` instance. See :attr:`Scrapinghub.projects` attribute.
 
     Usage::
@@ -98,7 +98,7 @@ class Project(object):
 
     Not a public constructor: use :class:`ScrapinghubClient` instance or
     :class:`Projects` instance to get a :class:`Project` instance. See
-    :meth:`Scrapinghub.get_project` or :meth:`Projects.get` methods.
+    :meth:`ScrapinghubClient.get_project` or :meth:`Projects.get` methods.
 
     :ivar key: string project id.
     :ivar activity: :class:`Activity` resource object.