Update documentation of stock_package

This commit is contained in:
Cédric Krier
2026-02-07 19:31:15 +01:00
parent 3e4e9198a3
commit a81884484a
4 changed files with 100 additions and 8 deletions
+18
View File
@@ -42,6 +42,7 @@ 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)
* Allow package type to be deactivated
* Add volume dimensions to package
@@ -50,57 +51,74 @@ Version 6.4.0 - 2022-05-02
* Remove support for Python 3.6
Version 6.2.0 - 2021-11-01
--------------------------
* Bug fixes (see mercurial logs for details)
* Remove dummy label report
Version 6.0.0 - 2021-05-03
--------------------------
* Bug fixes (see mercurial logs for details)
* Include package weight to weight parcel
* Add package weight
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)
* Add open/closed state on package
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)
* Check package also when packing shipment
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
--------------------------
* Initial release
+67
View File
@@ -0,0 +1,67 @@
******
Design
******
The stock package module introduces or extends the following concepts.
.. _model-stock.package:
Package
=======
A *package* represents a physical container that groups `stock moves
<stock:model-stock.move>` from the same `shipment
<stock:concept-stock.shipment>`.
The packages are numbered using the `sequence <trytond:model-ir.sequence>` set
in the `Stock Configuration <stock:model-stock.configuration>`.
Wizards
-------
.. _wizard-stock.package.pack:
Pack Package
^^^^^^^^^^^^
The *Pack Package* wizard is used to put a defined quantity of a selected
`stock move <stock:model-stock.move>` into a package.
.. _model-stock.package.type:
Package Type
============
A *Package Type* stores common properties of `packages <model-stock.package>`.
.. seealso::
The package types can be found by opening the main menu item:
|Inventory & Stock --> Configuration --> Package Types|__
.. |Inventory & Stock --> Configuration --> Package Types| replace:: :menuselection:`Inventory & Stock --> Configuration --> Package Types`
__ https://demo.tryton.org/model/stock.package.type
.. _concept-stock.shipment:
Shipment
========
When the *Stock Package Module* is activated, the `customer shipmment
<stock:model-stock.shipment.out>`, `supplier return shipment
<stock:model-stock.shipment.in.return>` and `internal shipment
<stock:model-stock.shipment.internal>` concepts gain properties to manage
`packages <model-stock.package>`.
Wizards
-------
.. _wizard-stock.shipment.pack:
Pack Shipment
^^^^^^^^^^^^^
The *Pack Shipment* wizard is used to create `package <model-stock.package>`
for a shipment.
The created package can be put inside another package or can include other
packages.
+8 -8
View File
@@ -1,13 +1,13 @@
####################
Stock Package Module
####################
The stock package module allows to store packaging information about customer
and supplier return shipments.
The *Stock Package Module* adds support for handling packages for shipments.
It allows stock moves to be grouped into packages, representing physical
containers such as boxes or pallets.
Package
*******
.. toctree::
:maxdepth: 2
A package groups together some moves from the same shipment.
The packages can be organized in a tree structure.
If a package is defined on a shipment, this one could be set to *Done* only if
all moves are packaged.
design
releases
+7
View File
@@ -0,0 +1,7 @@
.. _releases-index:
=============
Release notes
=============
.. include:: ../CHANGELOG