diff --git a/modules/purchase_request/CHANGELOG b/modules/purchase_request/CHANGELOG index a0ce40d4c6..8925d6c878 100644 --- a/modules/purchase_request/CHANGELOG +++ b/modules/purchase_request/CHANGELOG @@ -33,57 +33,70 @@ 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) * Use supplier currency as default * 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) * Add summary to request line * Add relate from request to purchase and from purchase to request Version 5.8.0 - 2020-11-02 +-------------------------- * Bug fixes (see mercurial logs for details) * Remove support for Python 3.5 * Rename purchase request state from cancel to cancelled Version 5.6.0 - 2020-05-04 +-------------------------- * Bug fixes (see mercurial logs for details) * Add employee on requests for some states * Allow setting unit on request without product 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 find_best_product_supplier method 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) * Make description on purchase request optional * Warns when the warehouse of a purchase differs from its purchase requests Version 4.6.0 - 2017-10-30 +-------------------------- * Bug fixes (see mercurial logs for details) * Remove required on request origin Version 4.4.0 - 2017-05-01 +-------------------------- * Bug fixes (see mercurial logs for details) * Add requests on purchase line Version 4.2.0 - 2016-11-28 +-------------------------- * Bug fixes (see mercurial logs for details) * Allow request without product * Group requests of same product and unit into one purchase line Version 4.0.0 - 2016-05-02 +-------------------------- * Initial release diff --git a/modules/purchase_request/doc/design.rst b/modules/purchase_request/doc/design.rst new file mode 100644 index 0000000000..51dc4da045 --- /dev/null +++ b/modules/purchase_request/doc/design.rst @@ -0,0 +1,52 @@ +****** +Design +****** + +The *Purchase Request Module* introduces some new concepts. + +.. _model-purchase.request: + +Purchase Request +================ + +The *Purchase Request* is used to manage the need to purchase `Products +`. +Each request stores several information such as the quantity to purchase, the +best purchase date and the expected supply date. +A purchase request progresses through several different states until it is +either done or gets cancelled. + +.. note:: + The purchase requests are not meant to be created by the users. + +.. seealso:: + + Purchase Requests can be found by opening the main menu item: + + |Purchases --> Purchase Requests|__ + + .. |Purchases --> Purchase Requests| replace:: :menuselection:`Purchases --> Purchase Requests` + __ https://demo.tryton.org/model/purchase.request + +Wizards +~~~~~~~ + +.. _wizard-purchase.request.create_purchase: + +Create Purchase +^^^^^^^^^^^^^^^ + +The *Create Purchase* wizard creates `Purchases +` for the selected draft purchase requests +grouped by `Warehouses ` and `Parties +`. +Once purchased the request's state is updated following the state of the +purchase. + +.. _wizard-purchase.request.handle.purchase.cancellation: + +Handle Purchase Cancellation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The *Handle Purchase Cancellation* wizard helps the user to reset to draft or +cancel the requests for which the purchase has been cancelled. diff --git a/modules/purchase_request/doc/index.rst b/modules/purchase_request/doc/index.rst index 8960bcc908..735d2223a4 100644 --- a/modules/purchase_request/doc/index.rst +++ b/modules/purchase_request/doc/index.rst @@ -1,39 +1,12 @@ +####################### Purchase Request Module ####################### -The Purchase Request module introduces the concept of Purchase Requests which -are central points to collect purchase requests generated by other process from -Tryton. +The *Purchase Request Module* provides everything needed to manage purchase +requests generated by other processes. -Purchase Request -**************** +.. toctree:: + :maxdepth: 2 -A purchase request defines the need to purchase a product. It -is linked to a warehouse and possibly a supplier, it contains a -ideal purchase date and an expected supply date. A purchase request -can be in one of these states: - -* Draft - - A draft purchase request is a request that is not linked to a - purchase. - -* Purchased - - A Purchased request is a request that is linked to a purchase which - is not Done or Cancelled. - -* Done - - A purchase request is in state Done if it is linked to a Purchase - which is in state Done. - -* Cancelled - - A purchase request is Cancelled if it is linked to a Purchase - which is cancelled. - -A wizard allows to create purchases based on a selection of draft purchase -requests. The new purchases contains one purchase line by product and unit and -group them by warehouses and by suppliers. Once the purchases are created, the -corresponding purchase requests are set to the state Purchased. + design + releases diff --git a/modules/purchase_request/doc/releases.rst b/modules/purchase_request/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/purchase_request/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/purchase_request/setup.py b/modules/purchase_request/setup.py index 7e3d8749ee..a6454f6717 100755 --- a/modules/purchase_request/setup.py +++ b/modules/purchase_request/setup.py @@ -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): @@ -60,7 +63,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-purchase-request/', "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://code.tryton.org/tryton', }, diff --git a/modules/purchase_request/tryton.cfg b/modules/purchase_request/tryton.cfg index 6b03bdfcb0..a5ce00e525 100644 --- a/modules/purchase_request/tryton.cfg +++ b/modules/purchase_request/tryton.cfg @@ -2,8 +2,10 @@ version=7.7.0 depends: ir - purchase + party product + purchase + stock xml: purchase_request.xml purchase.xml