Update documentation of stock forecast
This commit is contained in:
Sergi Almacellas Abellana
@@ -17,96 +17,123 @@ 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
|
||||
* Rename forecast state from cancel to cancelled
|
||||
|
||||
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)
|
||||
* Manage readonly state on Forecast Line
|
||||
|
||||
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
|
||||
* Deactivate forecast with passed period
|
||||
|
||||
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-24
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
|
||||
Version 2.2.0 - 2011-10-25
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
* Forecast creates draft moves only on demand
|
||||
* Forecast works at warehouse level
|
||||
* Allow 'production' as destination
|
||||
|
||||
Version 2.0.0 - 2011-04-27
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
|
||||
Version 1.8.0 - 2010-11-01
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
|
||||
Version 1.6.0 - 2010-05-12
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
* Add default search value on forecast
|
||||
* Remove egenix-mx-base and replace it by python-dateutil
|
||||
|
||||
Version 1.4.0 - 2009-10-19
|
||||
--------------------------
|
||||
* Bug fixes (see mercurial logs for details)
|
||||
|
||||
Version 1.2.0 - 2009-08-10
|
||||
--------------------------
|
||||
* Initial release
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
Stock Forecast Module
|
||||
*********************
|
||||
|
||||
The *Stock Forecast Module* introduces this concepts:
|
||||
|
||||
.. _model-stock.forecast:
|
||||
|
||||
Forecast
|
||||
========
|
||||
|
||||
A *Forecast* represents the expected demand for some `Products
|
||||
<concept-product>` over a set period of time.
|
||||
Each *Forecast* has properties that holds information about the `Warehouse
|
||||
<stock:concept-stock.location.warehouse>`, period and destination `Location
|
||||
<stock:model-stock.location>` that is expected to require the stock.
|
||||
It also has a set of lines which list how much of each product will be shipped
|
||||
or received.
|
||||
|
||||
The forecasts are automatically deactivated after their period has passed.
|
||||
|
||||
.. seealso::
|
||||
|
||||
Forecasts are found by opening the main menu item:
|
||||
|
||||
|Inventory & Stock --> Forecasts|__
|
||||
|
||||
.. |Inventory & Stock --> Forecasts| replace:: :menuselection:`Inventory & Stock --> Forecasts`
|
||||
__ https://demo.tryton.org/model/stock.forecast
|
||||
|
||||
|
||||
Wizards
|
||||
-------
|
||||
|
||||
.. _wizard-stock.forecast.complete:
|
||||
|
||||
Complete Forecast
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
The *Complete Forecast* calculates forecast lines based on `Stock Moves
|
||||
<stock:model-stock.move>` that have happened in the past.
|
||||
@@ -1,52 +1,12 @@
|
||||
Stock Forecast Module
|
||||
#####################
|
||||
##############
|
||||
Stock Forecast
|
||||
##############
|
||||
|
||||
The stock forecast module provide a simple way to create stock moves
|
||||
toward customers with a date in the future. This allow other stock
|
||||
mecanism to anticipate customer demand.
|
||||
The *Stock Forecast Module* provides a simple way to represent predicted future demands.
|
||||
This allows the supply system to take this expected demand into account.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
Forecast
|
||||
********
|
||||
|
||||
The forecast form contains:
|
||||
|
||||
- A location from which the products will leave.
|
||||
- A destination (which is a customer location).
|
||||
- Two dates defining a period in the future.
|
||||
- A company
|
||||
- A list of forcast lines with:
|
||||
|
||||
- A product
|
||||
- A quantity which represent the total demand for the period
|
||||
- A minimal quantity for each move.
|
||||
- A unit of measure.
|
||||
|
||||
The "Complete Forecast" button allow to auto-complete forecast lines
|
||||
based on previous stock output for dates in the past.
|
||||
|
||||
The forecasts are deactivated automatically when their period has passed.
|
||||
|
||||
|
||||
Forecast States
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
Draft
|
||||
|
||||
It is the initial state and the state used for edition. No moves are
|
||||
linked to the forecast lines
|
||||
|
||||
Done
|
||||
|
||||
Once in state done, moves are created for each forecast line:
|
||||
|
||||
- They are spread homogeneously between the two dates of the
|
||||
forecast.
|
||||
|
||||
- Move quantities are bigger or equal to the minimal quantity set
|
||||
on the forecast line.
|
||||
|
||||
Cancelled
|
||||
|
||||
On a cancelled forecast all existing moves are cancelled and the form
|
||||
is readonly.
|
||||
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):
|
||||
@@ -57,7 +60,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/projects/modules-stock-forecast'),
|
||||
"Forum": 'https://www.tryton.org/forum',
|
||||
"Source Code": 'https://code.tryton.org/tryton',
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user