From: Raphael Michel <mail@raphaelmichel.de>
Date: Thu, 4 Oct 2018 07:47:48 +0000 (+0200)
Subject: Minor documentation fixes
X-Git-Tag: v2.0.0~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=90d30a4505e803b4a7155440e5daec68606ac6d8;p=thirdparty%2Fpython-fints.git

Minor documentation fixes
---

diff --git a/docs/debits.rst b/docs/debits.rst
index acf2dbc..f59837f 100644
--- a/docs/debits.rst
+++ b/docs/debits.rst
@@ -5,6 +5,7 @@ You can submit a SEPA debit XML file to the bank with the ``start_sepa_debit`` m
 
 .. autoclass:: fints.client.FinTS3Client
    :members: start_sepa_debit
+   :noindex:
 
 You should then enter a TAN, read our chapter :ref:`tans` to find out more.
 
diff --git a/docs/reading.rst b/docs/reading.rst
index 3355c5b..9c373f5 100644
--- a/docs/reading.rst
+++ b/docs/reading.rst
@@ -7,6 +7,7 @@ Fetching your bank accounts
 The most simple method allows you to get all bank accounts that your user has access to:
 
 .. autoclass:: fints.client.FinTS3Client
+   :noindex:
    :members: get_sepa_accounts
 
 This method will return a list of named tuples of the following type:
@@ -22,10 +23,11 @@ Fetching account balances
 You can fetch the current balance of an account with the ``get_balance`` operation.
 
 .. autoclass:: fints.client.FinTS3Client
-  :members: get_balance
+   :noindex:
+   :members: get_balance
 
 This method will return a list of ``Balance`` objects from the ``mt-940`` library. You can find more information
-in `balance <their documentation>`_.
+in `their documentation <https://mt940.readthedocs.io/en/latest/mt940.html#mt940.models.Balance>`_.
 
 
 Reading account statements
@@ -35,10 +37,11 @@ You can fetch the banking statement of an account within a certain timeframe wit
 operation.
 
 .. autoclass:: fints.client.FinTS3Client
+   :noindex:
    :members: get_statement
 
 This method will return a list of ``Transaction`` objects from the ``mt-940`` library. You can find more information
-in `their documentation`_.
+in `their documentation <https://mt940.readthedocs.io/en/latest/mt940.html#mt940.models.Transaction>`_.
 
 
 Fetching holdings
@@ -47,12 +50,9 @@ Fetching holdings
 You can fetch the holdings of an account with the ``get_holdings`` method:
 
 .. autoclass:: fints.client.FinTS3Client
+   :noindex:
    :members: get_holdings
 
 This method will return a list of ``Holding`` objects:
 
 .. autoclass:: fints.models.Holding
-
-
-.. _their documentation: https://mt940.readthedocs.io/en/latest/mt940.html#mt940.models.Transaction
-.. _balance: https://mt940.readthedocs.io/en/latest/mt940.html#mt940.models.Balance
diff --git a/docs/tans.rst b/docs/tans.rst
index 58e7fd3..df9f9ff 100644
--- a/docs/tans.rst
+++ b/docs/tans.rst
@@ -18,6 +18,7 @@ The returned values have a subtype ``fints.models.TANMethod``, with varying para
 used by the bank:
 
 .. autoclass:: fints.client.FinTS3Client
+   :noindex:
    :members: get_tan_methods
 
 .. autoclass:: fints.models.TANMethod1
@@ -77,6 +78,7 @@ Sending the TAN
 Once obtained the TAN, you can send it with the ``send_tan`` client method:
 
 .. autoclass:: fints.client.FinTS3Client
+   :noindex:
    :members: send_tan
 
 For example: