Update documentation of account stock landed cost weight

2024-10-17 09:27:32 +02:00
parent 2b188f1f0a
commit 422be751d9
5 changed files with 60 additions and 4 deletions
@@ -20,49 +20,63 @@ 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
 * Store allocation factors

 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
+--------------------------
 * Initial release
@@ -0,0 +1,23 @@
+******
+Design
+******
+
+The *Account Stock Landed Cost Weight Module* extends the following concepts:
+
+.. _model-account.landed_cost:
+
+Landed Cost
+===========
+
+When the *Account Stock Landed Cost Weight Module* is activated, the *Landed
+Cost* gains :guilabel:`By Weight` as a new option for the :guilabel:`Allocation
+Method`.
+
+Using :guilabel:`By Weight` allocates costs based on the weight of each
+incoming stock move.
+
+.. seealso::
+
+   The `Landed Cost <account_stock_landed_cost:model-account.landed_cost>`
+   concept is introduced by the :doc:`Account Stock Landed Cost Module
+   <account_stock_landed_cost:index>`.
@@ -1,5 +1,12 @@
+#######################################
 Account Stock Landed Cost Weight Module
 #######################################

-The account_stock_landed_cost_weight module adds an allocation method based on
-weight of each line. (The *Weight* is taken from the *Product Measurements*)
+The *Account Stock Landed Cost Weight Module* adds an allocation method based
+on weight to the landed costs.
+
+.. toctree::
+   :maxdepth: 2
+
+   design
+   releases
@@ -0,0 +1,7 @@
+.. _releases-index:
+
+=============
+Release notes
+=============
+
+.. include:: ../CHANGELOG
@@ -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-stock-landed-cost-weight'),
        "Forum": 'https://www.tryton.org/forum',
        "Source Code": 'https://code.tryton.org/tryton',
        },