Finish first pass on splunklib docstrings and modify docs spec to include inherited members.

Author: blovering

docs/index.rst

@@ -15,11 +15,15 @@ splunklib.binding
 
 .. autoclass:: Context
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autofunction:: handler
 
 .. autoclass:: HTTPError
     :members:
+    :inherited-members:
+    :undoc-members:
 
 splunklib.client
 ----------------
@@ -30,63 +34,103 @@ splunklib.client
 
 .. autoclass:: Collection
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: Endpoint
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: Entity
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: Service
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: AlertGroup
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: Conf
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: Confs
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: Stanza
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: Index
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: Input
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: Inputs
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: Job
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: Jobs
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: Message
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: SavedSearch
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: SavedSearches
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: Settings
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: Users
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: NotSupportedError
     :members:
+    :inherited-members:
+    :undoc-members:
 
 .. autoclass:: OperationError
     :members:
+    :inherited-members:
+    :undoc-members:
 
 splunklib.data
 --------------
@@ -99,6 +143,7 @@ splunklib.data
 
 .. autoclass:: Record
     :members:
+    :undoc-members:
 
 splunklib.results
 -----------------

splunklib/binding.py

@@ -121,22 +121,18 @@ class Context(object):
     authenticated by presenting credentials using the :meth:`login` method
     or by constructing the instance using the :func:`connect` function 
     which both creates and authenticates the instance.
-    """
 
-    # kwargs: scheme, host, port, app, owner, username, password
+    :param `host`: host name (default `localhost`)
+    :param `port`: port number (default 8089)
+    :param `scheme`: scheme for accessing service (default `https`)
+    :param `owner`: owner namespace (optional)
+    :param `app`: app context (optional)
+    :param `token`: session token to reuse (optional)
+    :param `username`: username to login with
+    :param `password`: password to login with
+    :param `handler`: HTTP request handler (optional)
+    """
     def __init__(self, handler=None, **kwargs):
-        """Constructs a new :class:`Context` instance using the given arguments.
-
-        :param `host`: host name (default `localhost`)
-        :param `port`: port number (default 8089)
-        :param `scheme`: scheme for accessing service (default `https`)
-        :param `owner`: owner namespace (optional)
-        :param `app`: app context (optional)
-        :param `token`: session token (optional)
-        :param `username`: username to login with
-        :param `password`: password to login with
-        :param `handler`: HTTP request handler (optional)
-        """
         self.http = HttpLib(handler)
         self.token = None
         self.prefix = prefix(**kwargs)