Rebuild docs with fixed references

dropbox · Jan 10, 2019 · 08cf819 · 08cf819
1 parent 0f26ac3
commit 08cf819
Show file tree

Hide file tree

Showing 17 changed files with 7,759 additions and 6,701 deletions.
diff --git a/dropbox/async_.py b/dropbox/async_.py
@@ -24,9 +24,9 @@ class LaunchResultBase(bb.Union):
     return true. To get the associated value of a tag (if one exists), use the
     corresponding ``get_*`` method.
 
-    :ivar str async_job_id: This response indicates that the processing is
-        asynchronous. The string is an id that can be used to obtain the status
-        of the asynchronous job.
+    :ivar str async.LaunchResultBase.async_job_id: This response indicates that
+        the processing is asynchronous. The string is an id that can be used to
+        obtain the status of the asynchronous job.
     """
 
     _catch_all = None
@@ -38,7 +38,7 @@ def async_job_id(cls, val):
         value ``val``.
 
         :param str val:
-        :rtype: LaunchResultBase
+        :rtype: async_.LaunchResultBase
         """
         return cls('async_job_id', val)
 
@@ -81,7 +81,8 @@ class LaunchEmptyResult(LaunchResultBase):
     return true. To get the associated value of a tag (if one exists), use the
     corresponding ``get_*`` method.
 
-    :ivar complete: The job finished synchronously and successfully.
+    :ivar async.LaunchEmptyResult.complete: The job finished synchronously and
+        successfully.
     """
 
     # Attribute is overwritten below the class definition
@@ -107,8 +108,8 @@ class PollArg(bb.Struct):
     """
     Arguments for methods that poll the status of an asynchronous job.
 
-    :ivar async_job_id: Id of the asynchronous job. This is the value of a
-        response returned from the method that launched the job.
+    :ivar async.PollArg.async_job_id: Id of the asynchronous job. This is the
+        value of a response returned from the method that launched the job.
     """
 
     __slots__ = [
@@ -170,7 +171,8 @@ class PollResultBase(bb.Union):
     return true. To get the associated value of a tag (if one exists), use the
     corresponding ``get_*`` method.
 
-    :ivar in_progress: The asynchronous job is still in progress.
+    :ivar async.PollResultBase.in_progress: The asynchronous job is still in
+        progress.
     """
 
     _catch_all = None
@@ -202,7 +204,8 @@ class PollEmptyResult(PollResultBase):
     return true. To get the associated value of a tag (if one exists), use the
     corresponding ``get_*`` method.
 
-    :ivar complete: The asynchronous job has completed successfully.
+    :ivar async.PollEmptyResult.complete: The asynchronous job has completed
+        successfully.
     """
 
     # Attribute is overwritten below the class definition
@@ -232,10 +235,10 @@ class PollError(bb.Union):
     return true. To get the associated value of a tag (if one exists), use the
     corresponding ``get_*`` method.
 
-    :ivar invalid_async_job_id: The job ID is invalid.
-    :ivar internal_error: Something went wrong with the job on Dropbox's end.
-        You'll need to verify that the action you were taking succeeded, and if
-        not, try again. This should happen very rarely.
+    :ivar async.PollError.invalid_async_job_id: The job ID is invalid.
+    :ivar async.PollError.internal_error: Something went wrong with the job on
+        Dropbox's end. You'll need to verify that the action you were taking
+        succeeded, and if not, try again. This should happen very rarely.
     """
 
     _catch_all = 'other'

diff --git a/dropbox/auth.py b/dropbox/auth.py
@@ -21,10 +21,10 @@ class AccessError(bb.Union):
     return true. To get the associated value of a tag (if one exists), use the
     corresponding ``get_*`` method.
 
-    :ivar InvalidAccountTypeError invalid_account_type: Current account type
-        cannot access the resource.
-    :ivar PaperAccessError paper_access_denied: Current account cannot access
-        Paper.
+    :ivar InvalidAccountTypeError auth.AccessError.invalid_account_type: Current
+        account type cannot access the resource.
+    :ivar PaperAccessError auth.AccessError.paper_access_denied: Current account
+        cannot access Paper.
     """
 
     _catch_all = 'other'
@@ -37,8 +37,8 @@ def invalid_account_type(cls, val):
         Create an instance of this class set to the ``invalid_account_type`` tag
         with value ``val``.
 
-        :param InvalidAccountTypeError val:
-        :rtype: AccessError
+        :param auth.InvalidAccountTypeError val:
+        :rtype: auth.AccessError
         """
         return cls('invalid_account_type', val)
 
@@ -48,8 +48,8 @@ def paper_access_denied(cls, val):
         Create an instance of this class set to the ``paper_access_denied`` tag
         with value ``val``.
 
-        :param PaperAccessError val:
-        :rtype: AccessError
+        :param auth.PaperAccessError val:
+        :rtype: auth.AccessError
         """
         return cls('paper_access_denied', val)
 
@@ -83,7 +83,7 @@ def get_invalid_account_type(self):
 
         Only call this if :meth:`is_invalid_account_type` is true.
 
-        :rtype: InvalidAccountTypeError
+        :rtype: auth.InvalidAccountTypeError
         """
         if not self.is_invalid_account_type():
             raise AttributeError("tag 'invalid_account_type' not set")
@@ -95,7 +95,7 @@ def get_paper_access_denied(self):
 
         Only call this if :meth:`is_paper_access_denied` is true.
 
-        :rtype: PaperAccessError
+        :rtype: auth.PaperAccessError
         """
         if not self.is_paper_access_denied():
             raise AttributeError("tag 'paper_access_denied' not set")
@@ -117,13 +117,13 @@ class AuthError(bb.Union):
     return true. To get the associated value of a tag (if one exists), use the
     corresponding ``get_*`` method.
 
-    :ivar invalid_access_token: The access token is invalid.
-    :ivar invalid_select_user: The user specified in 'Dropbox-API-Select-User'
-        is no longer on the team.
-    :ivar invalid_select_admin: The user specified in 'Dropbox-API-Select-Admin'
-        is not a Dropbox Business team admin.
-    :ivar user_suspended: The user has been suspended.
-    :ivar expired_access_token: The access token has expired.
+    :ivar auth.AuthError.invalid_access_token: The access token is invalid.
+    :ivar auth.AuthError.invalid_select_user: The user specified in
+        'Dropbox-API-Select-User' is no longer on the team.
+    :ivar auth.AuthError.invalid_select_admin: The user specified in
+        'Dropbox-API-Select-Admin' is not a Dropbox Business team admin.
+    :ivar auth.AuthError.user_suspended: The user has been suspended.
+    :ivar auth.AuthError.expired_access_token: The access token has expired.
     """
 
     _catch_all = 'other'
@@ -202,10 +202,10 @@ class InvalidAccountTypeError(bb.Union):
     return true. To get the associated value of a tag (if one exists), use the
     corresponding ``get_*`` method.
 
-    :ivar endpoint: Current account type doesn't have permission to access this
-        route endpoint.
-    :ivar feature: Current account type doesn't have permission to access this
-        feature.
+    :ivar auth.InvalidAccountTypeError.endpoint: Current account type doesn't
+        have permission to access this route endpoint.
+    :ivar auth.InvalidAccountTypeError.feature: Current account type doesn't
+        have permission to access this feature.
     """
 
     _catch_all = 'other'
@@ -254,8 +254,9 @@ class PaperAccessError(bb.Union):
     return true. To get the associated value of a tag (if one exists), use the
     corresponding ``get_*`` method.
 
-    :ivar paper_disabled: Paper is disabled.
-    :ivar not_paper_user: The provided user has not used Paper yet.
+    :ivar auth.PaperAccessError.paper_disabled: Paper is disabled.
+    :ivar auth.PaperAccessError.not_paper_user: The provided user has not used
+        Paper yet.
     """
 
     _catch_all = 'other'
@@ -302,9 +303,10 @@ class RateLimitError(bb.Struct):
     """
     Error occurred because the app is being rate limited.
 
-    :ivar reason: The reason why the app is being rate limited.
-    :ivar retry_after: The number of seconds that the app should wait before
-        making another request.
+    :ivar auth.RateLimitError.reason: The reason why the app is being rate
+        limited.
+    :ivar auth.RateLimitError.retry_after: The number of seconds that the app
+        should wait before making another request.
     """
 
     __slots__ = [
@@ -333,7 +335,7 @@ def reason(self):
         """
         The reason why the app is being rate limited.
 
-        :rtype: RateLimitReason
+        :rtype: auth.RateLimitReason
         """
         if self._reason_present:
             return self._reason_value
@@ -392,10 +394,10 @@ class RateLimitReason(bb.Union):
     return true. To get the associated value of a tag (if one exists), use the
     corresponding ``get_*`` method.
 
-    :ivar too_many_requests: You are making too many requests in the past few
-        minutes.
-    :ivar too_many_write_operations: There are currently too many write
-        operations happening in the user's Dropbox.
+    :ivar auth.RateLimitReason.too_many_requests: You are making too many
+        requests in the past few minutes.
+    :ivar auth.RateLimitReason.too_many_write_operations: There are currently
+        too many write operations happening in the user's Dropbox.
     """
 
     _catch_all = 'other'
@@ -440,9 +442,10 @@ def __repr__(self):
 
 class TokenFromOAuth1Arg(bb.Struct):
     """
-    :ivar oauth1_token: The supplied OAuth 1.0 access token.
-    :ivar oauth1_token_secret: The token secret associated with the supplied
-        access token.
+    :ivar auth.TokenFromOAuth1Arg.oauth1_token: The supplied OAuth 1.0 access
+        token.
+    :ivar auth.TokenFromOAuth1Arg.oauth1_token_secret: The token secret
+        associated with the supplied access token.
     """
 
     __slots__ = [
@@ -529,10 +532,10 @@ class TokenFromOAuth1Error(bb.Union):
     return true. To get the associated value of a tag (if one exists), use the
     corresponding ``get_*`` method.
 
-    :ivar invalid_oauth1_token_info: Part or all of the OAuth 1.0 access token
-        info is invalid.
-    :ivar app_id_mismatch: The authorized app does not match the app associated
-        with the supplied access token.
+    :ivar auth.TokenFromOAuth1Error.invalid_oauth1_token_info: Part or all of
+        the OAuth 1.0 access token info is invalid.
+    :ivar auth.TokenFromOAuth1Error.app_id_mismatch: The authorized app does not
+        match the app associated with the supplied access token.
     """
 
     _catch_all = 'other'
@@ -577,8 +580,8 @@ def __repr__(self):
 
 class TokenFromOAuth1Result(bb.Struct):
     """
-    :ivar oauth2_token: The OAuth 2.0 token generated from the supplied OAuth
-        1.0 token.
+    :ivar auth.TokenFromOAuth1Result.oauth2_token: The OAuth 2.0 token generated
+        from the supplied OAuth 1.0 token.
     """
 
     __slots__ = [

diff --git a/dropbox/common.py b/dropbox/common.py
@@ -18,14 +18,15 @@ class PathRoot(bb.Union):
     return true. To get the associated value of a tag (if one exists), use the
     corresponding ``get_*`` method.
 
-    :ivar home: Paths are relative to the authenticating user's home namespace,
-        whether or not that user belongs to a team.
-    :ivar str root: Paths are relative to the authenticating user's root
-        namespace (This results in :field:`PathRootError.invalid_root` if the
-        user's root namespace has changed.).
-    :ivar str namespace_id: Paths are relative to given namespace id (This
-        results in :field:`PathRootError.no_permission` if you don't have access
-        to this namespace.).
+    :ivar common.PathRoot.home: Paths are relative to the authenticating user's
+        home namespace, whether or not that user belongs to a team.
+    :ivar str common.PathRoot.root: Paths are relative to the authenticating
+        user's root namespace (This results in
+        :field:`PathRootError.invalid_root` if the user's root namespace has
+        changed.).
+    :ivar str common.PathRoot.namespace_id: Paths are relative to given
+        namespace id (This results in :field:`PathRootError.no_permission` if
+        you don't have access to this namespace.).
     """
 
     _catch_all = 'other'
@@ -41,7 +42,7 @@ def root(cls, val):
         ``val``.
 
         :param str val:
-        :rtype: PathRoot
+        :rtype: common.PathRoot
         """
         return cls('root', val)
 
@@ -52,7 +53,7 @@ def namespace_id(cls, val):
         value ``val``.
 
         :param str val:
-        :rtype: PathRoot
+        :rtype: common.PathRoot
         """
         return cls('namespace_id', val)
 
@@ -130,10 +131,11 @@ class PathRootError(bb.Union):
     return true. To get the associated value of a tag (if one exists), use the
     corresponding ``get_*`` method.
 
-    :ivar RootInfo invalid_root: The root namespace id in Dropbox-API-Path-Root
-        header is not valid. The value of this error is use's latest root info.
-    :ivar no_permission: You don't have permission to access the namespace id in
-        Dropbox-API-Path-Root  header.
+    :ivar RootInfo common.PathRootError.invalid_root: The root namespace id in
+        Dropbox-API-Path-Root header is not valid. The value of this error is
+        use's latest root info.
+    :ivar common.PathRootError.no_permission: You don't have permission to
+        access the namespace id in Dropbox-API-Path-Root  header.
     """
 
     _catch_all = 'other'
@@ -148,8 +150,8 @@ def invalid_root(cls, val):
         Create an instance of this class set to the ``invalid_root`` tag with
         value ``val``.
 
-        :param RootInfo val:
-        :rtype: PathRootError
+        :param common.RootInfo val:
+        :rtype: common.PathRootError
         """
         return cls('invalid_root', val)
 
@@ -184,7 +186,7 @@ def get_invalid_root(self):
 
         Only call this if :meth:`is_invalid_root` is true.
 
-        :rtype: RootInfo
+        :rtype: common.RootInfo
         """
         if not self.is_invalid_root():
             raise AttributeError("tag 'invalid_root' not set")
@@ -202,11 +204,12 @@ class RootInfo(bb.Struct):
     """
     Information about current user's root.
 
-    :ivar root_namespace_id: The namespace ID for user's root namespace. It will
-        be the namespace ID of the shared team root if the user is member of a
-        team with a separate team root. Otherwise it will be same as
-        ``RootInfo.home_namespace_id``.
-    :ivar home_namespace_id: The namespace ID for user's home namespace.
+    :ivar common.RootInfo.root_namespace_id: The namespace ID for user's root
+        namespace. It will be the namespace ID of the shared team root if the
+        user is member of a team with a separate team root. Otherwise it will be
+        same as ``RootInfo.home_namespace_id``.
+    :ivar common.RootInfo.home_namespace_id: The namespace ID for user's home
+        namespace.
     """
 
     __slots__ = [
@@ -293,8 +296,8 @@ class TeamRootInfo(RootInfo):
     """
     Root info when user is member of a team with a separate root namespace ID.
 
-    :ivar home_path: The path for user's home directory under the shared team
-        root.
+    :ivar common.TeamRootInfo.home_path: The path for user's home directory
+        under the shared team root.
     """
 
     __slots__ = [

diff --git a/dropbox/contacts.py b/dropbox/contacts.py
@@ -21,7 +21,8 @@
 
 class DeleteManualContactsArg(bb.Struct):
     """
-    :ivar email_addresses: List of manually added contacts to be deleted.
+    :ivar contacts.DeleteManualContactsArg.email_addresses: List of manually
+        added contacts to be deleted.
     """
 
     __slots__ = [
@@ -77,9 +78,9 @@ class DeleteManualContactsError(bb.Union):
     return true. To get the associated value of a tag (if one exists), use the
     corresponding ``get_*`` method.
 
-    :ivar list of [str] contacts_not_found: Can't delete contacts from this
-        list. Make sure the list only has manually added contacts. The deletion
-        was cancelled.
+    :ivar list of [str] contacts.DeleteManualContactsError.contacts_not_found:
+        Can't delete contacts from this list. Make sure the list only has
+        manually added contacts. The deletion was cancelled.
     """
 
     _catch_all = 'other'
@@ -93,7 +94,7 @@ def contacts_not_found(cls, val):
         with value ``val``.
 
         :param list of [str] val:
-        :rtype: DeleteManualContactsError
+        :rtype: contacts.DeleteManualContactsError
         """
         return cls('contacts_not_found', val)