details:   https://code.tryton.org/tryton/commit/54a716507f92
branch:    default
user:      Sergi Almacellas Abellana <[email protected]>
date:      Mon Mar 30 22:13:32 2026 +0200
description:
        Update documentation of production work module
diffstat:

 modules/production_work/CHANGELOG        |   13 ++++
 modules/production_work/doc/design.rst   |  100 +++++++++++++++++++++++++++++++
 modules/production_work/doc/index.rst    |   66 ++------------------
 modules/production_work/doc/releases.rst |    7 ++
 4 files changed, 127 insertions(+), 59 deletions(-)

diffs (253 lines):

diff -r ed91286a17a3 -r 54a716507f92 modules/production_work/CHANGELOG
--- a/modules/production_work/CHANGELOG Mon Mar 30 22:13:40 2026 +0200
+++ b/modules/production_work/CHANGELOG Mon Mar 30 22:13:32 2026 +0200
@@ -40,46 +40,59 @@
 * 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
 * Add start and stop buttons on works
 
 Version 5.6.0 - 2020-05-04
+--------------------------
 * Bug fixes (see mercurial logs for details)
 * Make work center not required on request and draft states
 
 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
+--------------------------
 * Initial release
diff -r ed91286a17a3 -r 54a716507f92 modules/production_work/doc/design.rst
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/modules/production_work/doc/design.rst    Mon Mar 30 22:13:32 2026 +0200
@@ -0,0 +1,100 @@
+******
+Design
+******
+
+The *Production Work Module* introduces or extends the following concepts.
+
+.. _model-production.work.center:
+
+Work Center
+===========
+
+A *Work Center* represents a specific area or a machine in which a particular
+set of `Operations <production_routing:model-production.routing.operation>` is
+performed.
+Work centers can be organized into a tree structure representing a production
+chain, with each work center linked to a `Category
+<model-production.work.center.category>`.
+The cost of each work center can be defined using different methods, such as
+per cycle or per hour.
+
+.. seealso::
+
+   The *Work Centers* can be accessed via the main menu:
+
+      |Production --> Configuration --> Work Centers|__
+
+      .. |Production --> Configuration --> Work Centers| replace:: 
:menuselection:`Production --> Configuration --> Work Centers`
+      __ https://demo.tryton.org/model/production.work.center
+
+.. _model-production.work.center.category:
+
+Work Center Category
+====================
+
+The *Work Center Category* concept provides a way of grouping `Work Centers
+<model-production.work.center>`.
+
+.. seealso::
+
+   The list of *Work Center Categories* can be accessed via the main menu item:
+
+      |Production --> Configuration --> Work Center Categories|__
+
+      .. |Production --> Configuration --> Work Center Categories| replace:: 
:menuselection:`Production --> Configuration --> Work Center Categories`
+      __ https://demo.tryton.org/model/production.work.center.category
+
+.. _model-production.work:
+
+Work
+====
+
+A *Work* represents an `Operation
+<production_routing:model-production.routing.operation>` assigned to a `Work
+Center <model-production.work.center>` as part of a `Production order
+<production:model-production>`.
+
+Each work, at any time, can ben in one of several different states.
+A work progresses through these states until it is done.
+During this process, the number and the duration of each cycle are recorded to
+calculate the total cost of the work.
+
+.. seealso::
+
+   The list of *Works* can be accessed via the main menu:
+
+      |Production --> Works|__
+
+      .. |Production --> Works| replace:: :menuselection:`Production --> Works`
+      __ https://demo.tryton.org/model/production.work
+
+.. _model-production.routing.operation:
+
+Operation
+=========
+
+When the *Production Work Module* is activated, the operation can be linked to
+a `Work Center Category <model-production.work.center.category>` which
+determines which `Work Centers <model-production.work.center>` can support the
+operation.
+
+.. seealso::
+
+   The `Operation <production_routing:model-production.routing.operation>`
+   concept is introduced by the :doc:`Production Routing Module
+   <production_routing:index>`.
+
+.. _model-production:
+
+Production
+==========
+
+When the *Production Work Module* is activated, the production gains new
+properties such as the main `Work Center <model-production.work.center>` and
+the list of `Works <model-production.work>` that are defined by default from
+the `Routing <production_routing:model-production.routing>`.
+
+.. seealso::
+
+   The `Production <production:model-production>` concept is introduced by the
+   :doc:`Production Module <production:index>`.
diff -r ed91286a17a3 -r 54a716507f92 modules/production_work/doc/index.rst
--- a/modules/production_work/doc/index.rst     Mon Mar 30 22:13:40 2026 +0200
+++ b/modules/production_work/doc/index.rst     Mon Mar 30 22:13:32 2026 +0200
@@ -1,64 +1,12 @@
+######################
 Production Work Module
 ######################
 
-The production work module allows to manage work order for each production.
-It also adds in the production cost for the work cost.
-
-Work Center
-***********
-
-Work center are places in the warehouse where production operations are
-performed. They can be organized in a tree structure and each center can be
-linked to a category. A cost can be defined on the work center with two
-methods: ``Per Cycle`` or ``Per Hour``.
-
-Work
-****
-
-Works define for a production which operation to do at which work center.
-They also contains the number of cycles consumed to perform the operation.
-
-The work can be in one of these states:
-
-* Request
-
-  The linked production is still waiting.
-
-* Draft
-
-  The production has started but no cycle was already consumed.
-
-* Waiting
-
-  There are some draft cycles planned.
+The *Production Work Module* adds work orders and their associated costs for 
each
+production.
 
-* Running
-
-  There is at least one running cycle.
-
-* Finished
-
-  All the cycles are done (or cancelled).
-
-* Done
-
-  The production is done.
+.. toctree::
+   :maxdepth: 2
 
-The works are created on the waiting production using the linked routing. For
-each step of the routing, a work is created with the operation. The work center
-is set if the operation has a work center category, by choosing a children work
-center of this category. Or if the operation has no category, it is the
-production work center that is used.
-
-Cycle
-*****
-
-Cycles are used to count the consumption and the duration of the work. It also
-records the effective cost from the work center.
-
-The cycle can be in one of this states:
-
-* Draft
-* Running
-* Done
-* Cancelled
+   design
+   releases
diff -r ed91286a17a3 -r 54a716507f92 modules/production_work/doc/releases.rst
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/modules/production_work/doc/releases.rst  Mon Mar 30 22:13:32 2026 +0200
@@ -0,0 +1,7 @@
+.. _releases-index:
+
+=============
+Release notes
+=============
+
+.. include:: ../CHANGELOG

Reply via email to