docs: exceptions and fix sphinx

StellarCN · Aug 10, 2019 · a2d068a · a2d068a
1 parent 5b77900
commit a2d068a
Show file tree

Hide file tree

Showing 3 changed files with 85 additions and 6 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -49,6 +49,12 @@ EffectsCallBuilder
    :members:
    :inherited-members:
 
+FeeStatsCallBuilder
+-------------------
+.. autoclass:: stellar_sdk.call_builder.FeeStatsCallBuilder
+   :members:
+   :inherited-members:
+
 LedgersCallBuilder
 ------------------
 .. autoclass:: stellar_sdk.call_builder.LedgersCallBuilder
@@ -103,6 +109,81 @@ TransactionsCallBuilder
    :members:
    :inherited-members:
 
+Exceptions
+^^^^^^^^^^
+
+SdkError
+--------
+
+.. autoclass:: stellar_sdk.exceptions.SdkError
+   :members:
+
+ValueError
+----------
+
+.. autoclass:: stellar_sdk.exceptions.ValueError
+   :members:
+
+TypeError
+---------
+
+.. autoclass:: stellar_sdk.exceptions.TypeError
+   :members:
+
+BadSignatureError
+-----------------
+
+.. autoclass:: stellar_sdk.exceptions.BadSignatureError
+   :members:
+
+Ed25519PublicKeyInvalidError
+----------------------------
+
+.. autoclass:: stellar_sdk.exceptions.Ed25519PublicKeyInvalidError
+   :members:
+
+Ed25519SecretSeedInvalidError
+-----------------------------
+
+.. autoclass:: stellar_sdk.exceptions.Ed25519SecretSeedInvalidError
+   :members:
+
+MissingEd25519SecretSeedError
+-----------------------------
+
+.. autoclass:: stellar_sdk.exceptions.MissingEd25519SecretSeedError
+   :members:
+
+MemoInvalidException
+--------------------
+
+.. autoclass:: stellar_sdk.exceptions.MemoInvalidException
+   :members:
+
+AssetCodeInvalidError
+---------------------
+
+.. autoclass:: stellar_sdk.exceptions.AssetCodeInvalidError
+   :members:
+
+AssetIssuerInvalidError
+-----------------------
+
+.. autoclass:: stellar_sdk.exceptions.AssetIssuerInvalidError
+   :members:
+
+NoApproximationError
+--------------------
+
+.. autoclass:: stellar_sdk.exceptions.NoApproximationError
+   :members:
+
+SignatureExistError
+-------------------
+
+.. autoclass:: stellar_sdk.exceptions.SignatureExistError
+   :members:
+
 Keypair
 ^^^^^^^
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,14 +1,14 @@
-.. py-stellar-base documentation master file, created by
+.. py-stellar-sdk documentation master file, created by
    sphinx-quickstart on Sat Jan 20 11:58:02 2018.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to py-stellar-base's documentation!
+Welcome to py-stellar-sdk's documentation!
 ===========================================
 
 Quickstart
 ----------
-Here you'll find some basic examples on how to use the libary.
+Here you'll find some basic examples on how to use the library.
 
 .. toctree::
    :maxdepth: 2
@@ -31,12 +31,10 @@ Examples
 Find examples `here`_.
 
 
-
 Indices
 -------
 
 * :ref:`genindex`
-* :ref:`modindex`
 
 
 .. _here: https://github.com/StellarCN/py-stellar-base/tree/master/examples
diff --git a/docs/install.rst b/docs/install.rst
@@ -7,7 +7,7 @@ Installation
 Via pipenv or pip (Recommended)
 ===============================
 
-To install py-stellar-base, use pipenv to install the module:
+To install py-stellar-sdk, use pipenv to install the module:
 
 .. code-block:: text