update docs

Author: billbsing

convex_api/account.py

@@ -24,7 +24,21 @@
 
 
 class Account:
+    """
 
+        The Convex account class, contains the public/private keys and possibly an address.
+
+        You can create a new account object, it will only have it's public/private keys but does not have a valid account address.
+        To obtain a new account address, you need to call the :py:meth:`.ConvexAPI.create_account` with the new account object.
+
+        This is so that you can use the same public/private keys for multiple convex accounts.
+
+        Once you have your new account you need to save the public/private keys using the `export..` methods and also you
+        need to save the account address.
+
+        To re-use the account again, you can import the keys and set the account address using one of the `import..` methods.
+
+    """
     def __init__(self, private_key, address=None):
         """
         Create a new account with a private key as a Ed25519PrivateKey

convex_api/convex_api.py

@@ -1,7 +1,6 @@
 """
 
-
-    Convex
+    Convex API
 
 """
 
@@ -45,6 +44,19 @@ def __init__(self, url, language=LANGUAGE_LISP):
         self._language = language
 
     def create_account(self, account=None, sequence_retry_count=20):
+        """
+
+        Create a new account with the convex network.
+
+        :param object account: Account object that you whish to use as the signing account. The Account object
+            contains the public/private keys to access and submit commands on the convex network.
+
+        :param int sequence_retry_count: Number of retries to create the account. If too many clients are trying to
+            create accounts on the same node, then we will get sequence errors.
+
+        :returns: A new account object, or the current supplied account object with a new `address` property set
+
+        """
         if account is None:
             account = Account.create()
         create_account_url = urljoin(self._url, '/api/v1/createAccount')

docs/source/conf.py

@@ -104,7 +104,6 @@
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3', None),
-    'starfishapi': ('https://dex-company.github.io/starfish-py', None)
 }
 
 # -- Options for HTML output -------------------------------------------------