tryton-do/tryton
2
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Update documentation of product attribute

Browse Source
This commit is contained in:
Cédric Krier
2024-12-22 23:31:44 +01:00
parent c11e544273
commit 7ffc7ebd99
5 changed files with 110 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
modules/product_attribute/CHANGELOG
+20
View File
@@ -25,64 +25,84 @@ 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)
* Compute attributes name for variant
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)
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
--------------------------
* 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
--------------------------
* 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
--------------------------
* Initial release
modules/product_attribute/doc/design.rst
+71
View File
@@ -0,0 +1,71 @@
******
Design
******
The *Product Attribute Module* introduces the following concepts:
.. _model-product.template:
Product Template
================
When the *Product Attribute Module* is activated, product templates gain some
extra properties.
These include an `Attribute Set <model-product.attribute.set>` which defines
the `Attributes <model-product.attribute>` available for its variants.
.. seealso::
The `Product Template <product:model-product.template>` concept is
introduced by the :doc:`Product Module <product:index>`.
.. _model-product.product:
Product Variant
===============
When the *Product Attribute Module* is activated, product variants gain some
extra properties.
These include a list of `Attribute <model-product.attribute>` values and a name
calculated using these values.
.. seealso::
The `Product Variant <product:model-product.product>` concept is
introduced by the :doc:`Product Module <product:index>`.
.. _model-product.attribute:
Product Attribute
=================
An *Attribute* is a :class:`~trytond:trytond.model.DictSchemaMixin` that
defines a property for a `Product Variant <product:model-product.product>` such
as a color, a dimension and so on.
.. seealso::
The *Attributes* can be found by opening the main menu item:
|Products --> Configuration --> Attributes|__
.. |Products --> Configuration --> Attributes| replace:: :menuselection:`Products --> Configuration --> Attributes`
__ https://demo.tryton.org/model/product.attribute
.. _model-product.attribute.set:
Product Attribute Set
=====================
The *Attribute Set* groups `Product Attributes <model-product.attribute>`
together.
.. seealso::
The *Attribute Sets* can be found by opening the main menu item:
|Products --> Configuration --> Attribute Sets|__
.. |Products --> Configuration --> Attribute Sets| replace:: :menuselection:`Products --> Configuration --> Attribute Sets`
__ https://demo.tryton.org/model/product.attribute.set
modules/product_attribute/doc/index.rst
+6 -12
View File
@@ -1,17 +1,11 @@
########################
Product Attribute Module
########################
The Product Attribute module defines the following models: Attribute and
Attribute Set.
The *Product Attribute Module* adds attributes to product variants.
Attribute
*********
.. toctree::
:maxdepth: 2
An Attribute represents a property of a product, such as its colors, dimensions
and so on.
Attribute Set
*************
An Attribute Set is linked to products and allows to assign attribute values to
products.
design
releases
modules/product_attribute/doc/releases.rst
+7
View File
@@ -0,0 +1,7 @@
.. _releases-index:
=============
Release notes
=============
.. include:: ../CHANGELOG
modules/product_attribute/setup.py
+6 -2
View File
@@ -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/latest/modules-product-attribute',
"Forum": 'https://www.tryton.org/forum',
"Source Code": 'https://code.tryton.org/tryton',
},