From b9465aae477584083ffb1118d862ab622d2b2ab4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Tue, 15 Oct 2024 17:02:17 +0000 Subject: [PATCH] Update documentation of bank --- modules/bank/CHANGELOG | 19 ++++++++++++ modules/bank/doc/design.rst | 57 +++++++++++++++++++++++++++++++++++ modules/bank/doc/index.rst | 10 +++++- modules/bank/doc/releases.rst | 7 +++++ modules/bank/setup.py | 7 +++-- 5 files changed, 97 insertions(+), 3 deletions(-) create mode 100644 modules/bank/doc/design.rst create mode 100644 modules/bank/doc/releases.rst diff --git a/modules/bank/CHANGELOG b/modules/bank/CHANGELOG index fec36adfd0..d92096edb1 100644 --- a/modules/bank/CHANGELOG +++ b/modules/bank/CHANGELOG @@ -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 diff --git a/modules/bank/doc/design.rst b/modules/bank/doc/design.rst new file mode 100644 index 0000000000..1b9a77ffb8 --- /dev/null +++ b/modules/bank/doc/design.rst @@ -0,0 +1,57 @@ +****** +Design +****** + +The *Bank Module* introduces and extends the following concepts: + +.. _model-bank: + +Bank +==== + +The *Bank* associates a `Party ` with a BIC_. +A *Bank* can be created transparently when creating a `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 `. +A *Bank Account* can have different types of numbers including an IBAN_ and +multiple `Owners `. + +.. 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 ` concept is introduced by the + :doc:`Party Module `. + +.. _BIC: http://en.wikipedia.org/wiki/Bank_Identifier_Code +.. _IBAN: https://en.wikipedia.org/wiki/International_Bank_Account_Number diff --git a/modules/bank/doc/index.rst b/modules/bank/doc/index.rst index 845f215663..825a99a1ca 100644 --- a/modules/bank/doc/index.rst +++ b/modules/bank/doc/index.rst @@ -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 **** diff --git a/modules/bank/doc/releases.rst b/modules/bank/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/bank/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/bank/setup.py b/modules/bank/setup.py index c0b8aee12b..23559cc54b 100755 --- a/modules/bank/setup.py +++ b/modules/bank/setup.py @@ -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', },