Update documentation of account cash rounding

modules/account_cash_rounding/CHANGELOG

@@ -20,19 +20,24 @@ Version 6.6.0 - 2022-10-31
 * Bug fixes (see mercurial logs for details)
 
 Version 6.4.0 - 2022-05-02
+--------------------------
 * Bug fixes (see mercurial logs for details)
 * Add support for Python 3.10
 * Remove support for Python 3.6
 
 Version 6.2.0 - 2021-11-01
+--------------------------
 * Bug fixes (see mercurial logs for details)
 
 Version 6.0.0 - 2021-05-03
+--------------------------
 * Bug fixes (see mercurial logs for details)
 
 Version 5.8.0 - 2020-11-02
+--------------------------
 * Bug fixes (see mercurial logs for details)
 * Remove support for Python 3.5
 
 Version 5.6.0 - 2020-05-04
+--------------------------
 * Initial release

modules/account_cash_rounding/doc/design.rst

@@ -0,0 +1,85 @@
+******
+Design
+******
+
+The *Account Cash Rounding Module* extends the following concepts:
+
+.. _model-account.configuration:
+
+Account Configuration
+=====================
+
+The *Account Configuration* is extended with a checkbox to round the cash
+amounts and with two accounts to post the credited or debited amount due to the
+rounding.
+
+.. seealso::
+
+   The `Account Configuration <account:model-account.configuration>` concept is
+   introduced by the :doc:`Account Module <account:index>`.
+
+.. _model-currency.currency:
+
+Currency
+========
+
+When the *Account Cash Rounding Module* is activated, the *Currency* receives a
+:guilabel:`Cash Rounding Factor` that represents the currency's smallest
+available coin.
+
+.. seealso::
+
+   The `Currency <currency:model-currency.currency>` concept is introduced by
+   the :doc:`Currency Module <currency:index>`.
+
+.. _model-account.invoice:
+
+Invoice
+=======
+
+When the *Account Cash Rounding Module* is activated, the *Invoice* receives a
+:guilabel:`Cash Rounding` checkbox.
+For customer invoices, the checkbox is automatically checked according to the
+`Account Configuration <model-account.configuration>`.
+For supplier invoices, it is up to the user to decide whether to check it or
+not.
+If the checkbox is checked then the total amount is rounded based on the
+`Currency <currency:model-currency.currency>` and any remaining amount is
+posted to the corresponding accounts found in the *Account Configuration*.
+
+.. seealso::
+
+   The `Invoice <account_invoice:model-account.invoice>` concept is introduced
+   by the :doc:`Account Invoice Module <account_invoice:index>`.
+
+.. _model-purchase.purchase:
+
+Purchase
+========
+
+When the *Account Cash Rounding Module* is activated, the *Purchase* receives a
+:guilabel:`Cash Rounding` checkbox which by default is set to the value of the
+last purchase from the same supplier.
+When the checkbox is checked then the total amount is rounded based on the
+`Currency <currency:model-currency.currency>` and the *Purchase* transfers the
+:guilabel:`Cash Rounding` setting to the created `Invoices
+<account_invoice:model-account.invoice>`.
+
+.. seealso::
+
+   The `Purchase <purchase:model-purchase.purchase>` concept is introduced by
+   the :doc:`Purchase Module <purchase:index>`.
+
+.. _model-sale.sale:
+
+Sale
+====
+
+When the *Account Cash Rounding Module* is activated, the *Sale* rounds the
+total amount according to the `Account Configuration
+<model-account.configuration>`.
+
+.. seealso::
+
+   The `Sale <sale:model-sale.sale>` concept is introduced by the :doc:`Sale
+   Module <sale:index>`.

modules/account_cash_rounding/doc/index.rst

@@ -1,12 +1,11 @@
+############################
 Account Cash Rounding Module
 ############################
 
-The account_cash_rounding module allows cash amounts to be rounded using the
-cash rounding factor of the currency.
+The *Account Cash Rounding Module* round cash amounts by currency.
 
-When the invoice has to round the lines to pay, the exceeded amount is debited
-or credited to the accounts defined on the accounting configuration.
+.. toctree::
+   :maxdepth: 2
 
-Sales and invoices have the rounding activated by default based on the
-accounting configuration flag. Purchase use the last purchase for the supplier
-as the default value and transfer the value to the created invoices.
+   design
+   releases

modules/account_cash_rounding/doc/releases.rst

@@ -0,0 +1,7 @@
+.. _releases-index:
+
+=============
+Release notes
+=============
+
+.. include:: ../CHANGELOG

modules/account_cash_rounding/setup.py

@@ -14,8 +14,8 @@ def read(fname, slice=None):
     content = io.open(
         os.path.join(os.path.dirname(__file__), fname),
         'r', encoding='utf-8').read()
-    if slice:
-        content = '\n'.join(content.splitlines()[slice])
+    content = re.sub(
+        r'(?m)^\.\. toctree::\r?\n((^$|^\s.*$)\r?\n)*', '', content)
     return content
 
 
@@ -64,7 +64,8 @@ setup(name=name,
     download_url=download_url,
     project_urls={
         "Bug Tracker": 'https://bugs.tryton.org/',
-        "Documentation": 'https://docs.tryton.org/',
+        "Documentation": (
+            'https://docs.tryton.org/latest/modules-account-cash-rounding'),
         "Forum": 'https://www.tryton.org/forum',
         "Source Code": 'https://code.tryton.org/tryton',
         },