From 0590d00404ac6a678647557729c8f4a7ca9fcb66 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Thu, 8 Aug 2024 23:34:44 +0200 Subject: [PATCH] Update documentation of account payment SEPA CFONB --- modules/account_payment_sepa_cfonb/CHANGELOG | 15 +++++++++++++++ .../account_payment_sepa_cfonb/doc/design.rst | 19 +++++++++++++++++++ .../account_payment_sepa_cfonb/doc/index.rst | 10 +++++++++- .../doc/releases.rst | 7 +++++++ modules/account_payment_sepa_cfonb/setup.py | 9 +++++++-- 5 files changed, 57 insertions(+), 3 deletions(-) create mode 100644 modules/account_payment_sepa_cfonb/doc/design.rst create mode 100644 modules/account_payment_sepa_cfonb/doc/releases.rst diff --git a/modules/account_payment_sepa_cfonb/CHANGELOG b/modules/account_payment_sepa_cfonb/CHANGELOG index 5de4636600..a33d36add9 100644 --- a/modules/account_payment_sepa_cfonb/CHANGELOG +++ b/modules/account_payment_sepa_cfonb/CHANGELOG @@ -20,51 +20,66 @@ 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 +-------------------------- * Bug fixes (see mercurial logs for details) Version 5.4.0 - 2019-11-04 +-------------------------- * Bug fixes (see mercurial logs for details) Version 5.2.0 - 2019-05-06 +-------------------------- * Bug fixes (see mercurial logs for details) 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 +-------------------------- * Initial release diff --git a/modules/account_payment_sepa_cfonb/doc/design.rst b/modules/account_payment_sepa_cfonb/doc/design.rst new file mode 100644 index 0000000000..931b3e61a1 --- /dev/null +++ b/modules/account_payment_sepa_cfonb/doc/design.rst @@ -0,0 +1,19 @@ +****** +Design +****** + +The *Account Payment SEPA CFONB Module* extends the following concepts: + +.. _model-account.payment.journal: + +Payment Journal +=============== + +When the *Account Payment SEPA CFONB Module* is activated, the *Payment +Journal* receives a CFONB flavor for the SEPA receivables and payables. + +.. seealso:: + + The `Payment Journal ` + concept is introduced by the :doc:`Account Payment Module + `. diff --git a/modules/account_payment_sepa_cfonb/doc/index.rst b/modules/account_payment_sepa_cfonb/doc/index.rst index 38560f0cc7..1457e68d7e 100644 --- a/modules/account_payment_sepa_cfonb/doc/index.rst +++ b/modules/account_payment_sepa_cfonb/doc/index.rst @@ -1,4 +1,12 @@ +################################# Account Payment SEPA CFONB Module ################################# -The account_payment_sepa_cfonb module adds CFONB flavors to SEPA messages. +The *Account Payment SEPA CFONB Module* adds `CFONB +`_ flavors to SEPA messages. + +.. toctree:: + :maxdepth: 2 + + design + releases diff --git a/modules/account_payment_sepa_cfonb/doc/releases.rst b/modules/account_payment_sepa_cfonb/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/account_payment_sepa_cfonb/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/account_payment_sepa_cfonb/setup.py b/modules/account_payment_sepa_cfonb/setup.py index 6ec80cc4c8..066cf501f1 100755 --- a/modules/account_payment_sepa_cfonb/setup.py +++ b/modules/account_payment_sepa_cfonb/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,9 @@ 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-payment-sepa-cfonb'), "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://code.tryton.org/tryton', },