From c877d21bafa03427cf37a31feedeb92939324eec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Sat, 3 Aug 2024 12:31:21 +0200 Subject: [PATCH] Update documentation of carrier weight --- modules/carrier_weight/CHANGELOG | 22 ++++++++++++++++++++++ modules/carrier_weight/doc/design.rst | 20 ++++++++++++++++++++ modules/carrier_weight/doc/index.rst | 11 ++++++++--- modules/carrier_weight/doc/releases.rst | 7 +++++++ modules/carrier_weight/setup.py | 8 ++++++-- 5 files changed, 63 insertions(+), 5 deletions(-) create mode 100644 modules/carrier_weight/doc/design.rst create mode 100644 modules/carrier_weight/doc/releases.rst diff --git a/modules/carrier_weight/CHANGELOG b/modules/carrier_weight/CHANGELOG index c45a548adb..8be8e48c73 100644 --- a/modules/carrier_weight/CHANGELOG +++ b/modules/carrier_weight/CHANGELOG @@ -21,70 +21,92 @@ 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) * Use quantity if unit is weight as fallback for missing measurement 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) Version 3.2.0 - 2014-04-21 +-------------------------- * Bug fixes (see mercurial logs for details) Version 3.0.0 - 2013-10-21 +-------------------------- * Bug fixes (see mercurial logs for details) Version 2.8.0 - 2013-04-22 +-------------------------- * Bug fixes (see mercurial logs for details) Version 2.6.0 - 2012-10-22 +-------------------------- * Bug fixes (see mercurial logs for details) Version 2.4.0 - 2012-04-23 +-------------------------- * Initial release diff --git a/modules/carrier_weight/doc/design.rst b/modules/carrier_weight/doc/design.rst new file mode 100644 index 0000000000..199edee915 --- /dev/null +++ b/modules/carrier_weight/doc/design.rst @@ -0,0 +1,20 @@ +****** +Design +****** + +The *Carrier Weight Module* extends the following concepts: + +.. _model-carrier: + +Carrier +======= + +When the *Carrier Weight Module* is activated, the *Carrier* gains a new cost +method :guilabel:`Weight` and a new property that list prices per weight. +The price is calculated by finding the first line where the weight is greater +than the weight of the parcel. + +.. seealso:: + + The `Carrier ` concept is introduced by the + :doc:`Carrier Module `. diff --git a/modules/carrier_weight/doc/index.rst b/modules/carrier_weight/doc/index.rst index 6d05da8e73..4e94d67ce6 100644 --- a/modules/carrier_weight/doc/index.rst +++ b/modules/carrier_weight/doc/index.rst @@ -1,6 +1,11 @@ +##################### Carrier Weight Module ##################### -The carrier weight module adds a cost method based on weight. -The price is computed by finding the first line for which the weight is -greater. +The *Carrier Weight Module* adds a cost method based on the weight. + +.. toctree:: + :maxdepth: 2 + + design + releases diff --git a/modules/carrier_weight/doc/releases.rst b/modules/carrier_weight/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/carrier_weight/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/carrier_weight/setup.py b/modules/carrier_weight/setup.py index eb2bc4441d..34ab2521c3 100755 --- a/modules/carrier_weight/setup.py +++ b/modules/carrier_weight/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): @@ -63,7 +66,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-carrier-weight'), "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://code.tryton.org/tryton', },