From 3217b224a4d63406d0d4b59f9bd49f4dd0425945 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Fri, 18 Oct 2024 00:01:52 +0200 Subject: [PATCH] Update documentation of account statement OFX --- modules/account_statement_ofx/CHANGELOG | 9 +++++++++ modules/account_statement_ofx/doc/index.rst | 10 ++++++++-- modules/account_statement_ofx/doc/releases.rst | 7 +++++++ modules/account_statement_ofx/setup.py | 8 ++++++-- 4 files changed, 30 insertions(+), 4 deletions(-) create mode 100644 modules/account_statement_ofx/doc/releases.rst diff --git a/modules/account_statement_ofx/CHANGELOG b/modules/account_statement_ofx/CHANGELOG index 8ed82e3ad1..ce175c6c1c 100644 --- a/modules/account_statement_ofx/CHANGELOG +++ b/modules/account_statement_ofx/CHANGELOG @@ -20,33 +20,42 @@ 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) * Add unrecognized payees to origin description 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) * Rename StatementImport method ofx_informations to ofx_information Version 5.0.0 - 2018-10-01 +-------------------------- * Bug fixes (see mercurial logs for details) Version 4.8.0 - 2018-04-23 +-------------------------- * Initial release diff --git a/modules/account_statement_ofx/doc/index.rst b/modules/account_statement_ofx/doc/index.rst index 6915c405c6..2562512e0b 100644 --- a/modules/account_statement_ofx/doc/index.rst +++ b/modules/account_statement_ofx/doc/index.rst @@ -1,5 +1,11 @@ +############################ Account Statement OFX Module ############################ -The Account statement OFX module implement the import of the `OFX -`_ file as statement. +The *Account Statement OFX Module* implements the import of `OFX +`_ files as statements. + +.. toctree:: + :maxdepth: 2 + + releases diff --git a/modules/account_statement_ofx/doc/releases.rst b/modules/account_statement_ofx/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/account_statement_ofx/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/account_statement_ofx/setup.py b/modules/account_statement_ofx/setup.py index a29bd5df7d..b26356a5c6 100755 --- a/modules/account_statement_ofx/setup.py +++ b/modules/account_statement_ofx/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,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-statement-ofx'), "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://code.tryton.org/tryton', },