Update documentation of stock split

This commit is contained in:
Cédric Krier committed 2025-06-16 19:17:23 +02:00
1 parent 18491428f7
commit 9da4595239
5 files changed
+96 -9

No files matched your search

+21
View File
@@ -31,71 +31,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)
* Add shipment split
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
--------------------------
* 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-07-31
--------------------------
* Initial release
+55
View File
@@ -0,0 +1,55 @@
******
Design
******
The *Stock Split Module* introduces or extends the following concepts.
.. _model-stock.move:
Move
====
When the *Stock Split Module* is activated, the `Move <stock:model-stock.move>`
gain a :guilabel:`Split` button to launch the `Split Move
<wizard-stock.move.split>` wizard.
.. seealso::
The `Move <stock:model-stock.move>` concept is introduced by the :doc:`Stock
Module <stock:index>`.
Wizards
-------
.. _wizard-stock.move.split:
Split Move
^^^^^^^^^^
The *Split Move* wizard allows to split a move by :guilabel:`Quantity`.
If :guilabel:`Counts` is set, it will split only this number of times.
On occasion there can be a move with the remaining quantity.
.. _concept-stock.shipment:
Shipment
========
When the *Stock Split Module* is activated, the `Supplier Return Shipment
<stock:model-stock.shipment.in.return>`, the `Customer Shipment
<stock:model-stock.shipment.out>` and the `Internal Shipment
<stock:model-stock.shipment.internal>` gain a :guilabel:`Split` button to
launch the `Split Shipment <wizard-stock.shipment.split>` wizard.
Wizards
-------
.. _wizard-stock.shipment.split:
Split Shipment
^^^^^^^^^^^^^^
The *Split Shipment* wizard allows to split a `Shipment
<stock:concept-stock.shipment>` by selecting moves of the shipment shifted to a
new copy of the shipment.
+8 -7
View File
@@ -1,11 +1,12 @@
##################
Stock Split Module
##################
The Stock Split module adds on the stock move a wizard that allows to split them.
The move is split into moves of *Quantity*. If *Counts* is set, it will be
split only this number of times. On occasion there can be a move with the
remaining quantity.
The *Stock Split Module* adds a wizard on moves and shipments that allows you
to split them.
It also adds on *Customer*, *Supplier Return* and *Internal* shipments a wizard
that allows to split them. The selected moves of the shipment are shifted to a
new copy of the shipment.
.. toctree::
:maxdepth: 2
design
releases
+7
View File
@@ -0,0 +1,7 @@
.. _releases-index:
=============
Release notes
=============
.. include:: ../CHANGELOG
+5 -2
View File
@@ -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,7 @@ 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/modules-stock-split/',
"Forum": 'https://www.tryton.org/forum',
"Source Code": 'https://code.tryton.org/tryton',
},