Update documentation of purchase request quotation

2025-11-17 12:44:45 +01:00
parent e095f0fa92
commit ccb48987be
6 changed files with 112 additions and 28 deletions
@@ -33,34 +33,43 @@ 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)
 * Only allow the purchase request group to create quotations

 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
 * Add request date on report

 Version 4.8.0 - 2018-04-23
+--------------------------
 * Initial release
@@ -0,0 +1,80 @@
+******
+Design
+******
+
+The *Purchase Request Quotation Module* introduces some new concepts.
+
+.. _model-purchase.request.quotation:
+
+Purchase Request For Quotation
+==============================
+
+The *Purchase Request for Quotation* model tracks quotes for `Purchase Requests
+<purchase_request:model-purchase.request>` to multiple suppliers.
+A request for quotation has a line consisting of a quantity, price and supply
+date for each `Product <concept-product>` being quoted.
+
+.. seealso::
+
+   The Quotations can be found by opening the main menu item:
+
+      |Purchases --> Purchase Requests --> Quotations|__
+
+      .. |Purchases --> Purchase Requests --> Quotations| replace:: :menuselection:`Purchases --> Purchase Requests --> Quotations`
+      __ https://demo.tryton.org/model/purchase.request.quotation
+
+Reports
+-------
+
+.. _report-purchase.request.quotation:
+
+Purchase Request Quotation
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The *Purchase Request Quotation* provides a request for quotation that can be
+sent to the suppliers.
+It includes the relevant information for the supplier to make the quotation.
+
+Purchase Configuration
+======================
+
+When the *Purchase Request Quotation Module* is activated, the *Purchase
+Configuration* receives a new property to store the `Sequence
+<trytond:model-ir.sequence>` to number the `Purchase Request Quotation
+<model-purchase.request.quotation>`.
+
+.. seealso::
+
+   The `Purchase Configuration <purchase:model-purchase.configuration>` concept
+   is introduced by the :doc:`Purchase Module <purchase:index>`.
+
+.. _model-purchase.request:
+
+Purchase Request
+================
+
+When the *Purchase Request for Quotation Module* is activated, the purchase
+request receives a list of `Quotation <model-purchase.request.quotation>` lines
+from which it can select a preferred one to create a `Purchase
+<purchase:model-purchase.purchase>`.
+
+.. note::
+
+   If the prefered quotation is empty, the received line with the lower price
+   is used.
+
+.. seealso::
+
+   The `Purchase Request <purchase_request:model-purchase.request>` concept is
+   introduced by the :doc:`Purchase Request Module <purchase_request:index>`.
+
+Wizards
+-------
+
+.. _wizard-purchase.request.quotation.create:
+
+Create Purchase Request Quotation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The *Create Purchase Request Quotation* wizard helps users to create quotations
+for multiple suppliers and purchase requests.
@@ -1,29 +1,11 @@
-Purchase Request For Quotation Module
-#####################################
+Purchase Request Quotation Module
+#################################

-The Purchase Request for Quotation module allows users to ask quotations
-from selected purchase requests to different suppliers.
-Each request will collect quotation information from the supplier.
-The selection of the quotation is done by taking either the
-preferred_quotation field if not empty otherwise the first one ordered
-from the received quotations.
+The *Purchase Request Quotation Module* allows users to ask quotations
+from purchase requests to different suppliers.

-Quotation
-*********
+.. toctree::
+   :maxdepth: 2

- Supplier: The supplier.
- Company: The company which issue the request quotation.
- Supplier Address: The address of the supplier.
- Lines:
-
-  - Product: An optional reference to the product to quote.
-  - Description: The description of the product to quote.
-  - Supply Date: The expected date to supply.
-  - Quantity: The quantity to quote.
-  - Unit: The unit of measure in which is expressed the quantity.
-  - Unit Price: The unit price of the product expressed in the currency.
-  - Currency: define the currency to use for this quotation. All product prices
-    will be computed accordingly.
-
- State: The state of the quotation. May take one of the following
-  values: *Draft*, *Sent*, *Received*, *Rejected*, *Cancelled*.
+   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):
@@ -62,7 +65,9 @@ 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/latest/'
+            'modules-purchase-request-quotation/'),
        "Forum": 'https://www.tryton.org/forum',
        "Source Code": 'https://code.tryton.org/tryton',
        },
@@ -6,6 +6,7 @@ depends:
    currency
    party
    product
+    purchase
    purchase_request
 extras_depend:
    purchase_requisition