Update documentation of bank

This commit is contained in:
Cédric Krier committed 2024-10-15 17:02:17 +00:00
1 parent ed6e62d396
commit b9465aae47
5 files changed
+97 -3

No files matched your search

+19
View File
@@ -21,6 +21,7 @@ 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)
* Fill or create bank from IBAN
* Enforce uniqueness of IBAN
@@ -31,61 +32,79 @@ Version 6.4.0 - 2022-05-02
* 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
--------------------------
* Bug fixes (see mercurial logs for details)
* Show bank and currency in account record name
Version 5.4.0 - 2019-11-04
--------------------------
* Bug fixes (see mercurial logs for details)
* Validate and format BIC
Version 5.2.0 - 2019-05-06
--------------------------
* Bug fixes (see mercurial logs for details)
* Remove starting wildcard when searching on codes and numbers
Version 5.0.0 - 2018-10-01
--------------------------
* Bug fixes (see mercurial logs for details)
* Remove support for Python 2.7
Version 4.8.0 - 2018-04-23
--------------------------
* Bug fixes (see mercurial logs for details)
Version 4.6.0 - 2017-10-30
--------------------------
* Bug fixes (see mercurial logs for details)
Version 4.4.0 - 2017-05-01
--------------------------
* Bug fixes (see mercurial logs for details)
Version 4.2.0 - 2016-11-28
--------------------------
* Bug fixes (see mercurial logs for details)
Version 4.0.0 - 2016-05-02
--------------------------
* Bug fixes (see mercurial logs for details)
* Add Python3 support
Version 3.8.0 - 2015-11-02
--------------------------
* Bug fixes (see mercurial logs for details)
Version 3.6.0 - 2015-04-20
--------------------------
* Bug fixes (see mercurial logs for details)
* Add support for PyPy
Version 3.4.0 - 2014-10-20
--------------------------
* Bug fixes (see mercurial logs for details)
* Search also on compact number
Version 3.2.0 - 2014-04-21
--------------------------
* Bug fixes (see mercurial logs for details)
* Add IBAN format, validation and compact
* Add default access rights
Version 3.0.0 - 2013-10-21
--------------------------
* Initial release
+57
View File
@@ -0,0 +1,57 @@
******
Design
******
The *Bank Module* introduces and extends the following concepts:
.. _model-bank:
Bank
====
The *Bank* associates a `Party <party:model-party.party>` with a BIC_.
A *Bank* can be created transparently when creating a `Bank Account
<model-bank.account>` with an IBAN_.
.. seealso::
The *Banks* can be found by opening the main menu item:
|Banking --> Banks|__
.. |Banking --> Banks| replace:: :menuselection:`Banking --> Banks`
__ https://demo.tryton.org/model/bank
.. _model-bank.account:
Bank Account
============
The *Bank Account* represents an account at a `Bank <model-bank>`.
A *Bank Account* can have different types of numbers including an IBAN_ and
multiple `Owners <party:model-party.party>`.
.. seealso::
The *Bank Accounts* can be found by opening the main menu item:
|Banking --> Accounts|__
.. |Banking --> Accounts| replace:: :menuselection:`Banking --> Accounts`
__ https://demo.tryton.org/model/bank.account
.. _model-party.party:
Party
=====
When the *Bank Module* is activated, the *Party* gains a new property that
lists the :guilabel:`Bank Accounts` owned by the party.
.. seealso::
The `Party <party:model-party.party>` concept is introduced by the
:doc:`Party Module <party:index>`.
.. _BIC: http://en.wikipedia.org/wiki/Bank_Identifier_Code
.. _IBAN: https://en.wikipedia.org/wiki/International_Bank_Account_Number
+9 -1
View File
@@ -1,7 +1,15 @@
###########
Bank Module
###########
The bank module defines the concept of bank and account.
The *Bank Module* defines the concepts needed for storing banks and bank
accounts.
.. toctree::
:maxdepth: 2
design
releases
Bank
****
+7
View File
@@ -0,0 +1,7 @@
.. _releases-index:
=============
Release notes
=============
.. include:: ../CHANGELOG
+5 -2
View File
@@ -11,9 +11,12 @@ from setuptools import find_packages, setup
def read(fname):
return io.open(
content = io.open(
os.path.join(os.path.dirname(__file__), fname),
'r', encoding='utf-8').read()
content = re.sub(
r'(?m)^\.\. toctree::\r?\n((^$|^\s.*$)\r?\n)*', '', content)
return content
def get_require_version(name):
@@ -59,7 +62,7 @@ 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-bank',
"Forum": 'https://www.tryton.org/forum',
"Source Code": 'https://code.tryton.org/tryton',
},