From d40c0968abdb06c237162ae364417092d28660a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Thu, 8 Aug 2024 23:28:03 +0200 Subject: [PATCH] Update documentation of account invoice secondary unit --- .../account_invoice_secondary_unit/CHANGELOG | 6 ++++++ .../doc/design.rst | 19 +++++++++++++++++++ .../doc/index.rst | 11 +++++++++-- .../doc/releases.rst | 7 +++++++ .../account_invoice_secondary_unit/setup.py | 9 +++++++-- 5 files changed, 48 insertions(+), 4 deletions(-) create mode 100644 modules/account_invoice_secondary_unit/doc/design.rst create mode 100644 modules/account_invoice_secondary_unit/doc/releases.rst diff --git a/modules/account_invoice_secondary_unit/CHANGELOG b/modules/account_invoice_secondary_unit/CHANGELOG index 8a52cfb0ef..acb672f9ab 100644 --- a/modules/account_invoice_secondary_unit/CHANGELOG +++ b/modules/account_invoice_secondary_unit/CHANGELOG @@ -20,22 +20,28 @@ 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 +-------------------------- * Initial release diff --git a/modules/account_invoice_secondary_unit/doc/design.rst b/modules/account_invoice_secondary_unit/doc/design.rst new file mode 100644 index 0000000000..7f68f35074 --- /dev/null +++ b/modules/account_invoice_secondary_unit/doc/design.rst @@ -0,0 +1,19 @@ +****** +Design +****** + +The *Account Invoice Secondary Unit Module* extends the following concepts: + +.. _model-account.invoice: + +Invoice +======= + +When the *Account Invoice Secondary Unit Module* is activated, the *Invoice* +lines gain new properties that store another equivalent quantity and unit price +in a secondary `unit of measure `. + +.. seealso:: + + The `Invoice ` concept is introduced + by the :doc:`Account Invoice Module `. diff --git a/modules/account_invoice_secondary_unit/doc/index.rst b/modules/account_invoice_secondary_unit/doc/index.rst index e7e5bb799a..05e29f7586 100644 --- a/modules/account_invoice_secondary_unit/doc/index.rst +++ b/modules/account_invoice_secondary_unit/doc/index.rst @@ -1,5 +1,12 @@ +##################################### Account Invoice Secondary Unit Module ##################################### -The account invoice secondary unit module adds a secondary unit of measure on -invoice line. +The *Account Invoice Secondary Unit Module* adds a secondary unit of measure to +invoice lines. + +.. toctree:: + :maxdepth: 2 + + design + releases diff --git a/modules/account_invoice_secondary_unit/doc/releases.rst b/modules/account_invoice_secondary_unit/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/account_invoice_secondary_unit/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/account_invoice_secondary_unit/setup.py b/modules/account_invoice_secondary_unit/setup.py index 0493c9dc6e..99cedfe8dd 100755 --- a/modules/account_invoice_secondary_unit/setup.py +++ b/modules/account_invoice_secondary_unit/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-invoice-secondary-unit'), "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://code.tryton.org/tryton', },