Update documentation of commission waiting
Co-authored-by: David Harper <dave@libateq.org>
This commit is contained in:
co-authored by
David Harper
parent
78a2fd0de2
commit
a10b393b05
@@ -20,51 +20,66 @@ 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)
|
||||
|
||||
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
|
||||
--------------------------
|
||||
* Initial release
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
******
|
||||
Design
|
||||
******
|
||||
|
||||
The *Commission Waiting Module* extends the following concepts:
|
||||
|
||||
.. _model-commission.agent:
|
||||
|
||||
Agent
|
||||
=====
|
||||
|
||||
When the *Commission Waiting Module* is activated, the *Agent* gains a new
|
||||
property for the `Account <account:model-account.account>` to use to book
|
||||
their waiting commissions until they are invoiced.
|
||||
|
||||
.. seealso::
|
||||
|
||||
The `Agent <commission:model-commission.agent>` concept is introduced by the
|
||||
:doc:`Commission Module <commission:index>`.
|
||||
|
||||
.. _model-commission:
|
||||
|
||||
Commission
|
||||
==========
|
||||
|
||||
When the *Commission Waiting Module* is activated, the *Commission* gains a new
|
||||
property for the waiting `Account Move <account:model-account.move>` that is
|
||||
automatically generated if the `Agent <model-commission.agent>` has a waiting
|
||||
`Account <account:model-account.account>` set.
|
||||
|
||||
.. seealso::
|
||||
|
||||
The `Commission <commission:model-commission>` concept is introduced by the
|
||||
:doc:`Commission Module <commission:index>`.
|
||||
|
||||
.. _model-account.invoice:
|
||||
|
||||
Invoice
|
||||
=======
|
||||
|
||||
The *Invoice* concept is extended to also post and clear the waiting `Move
|
||||
<account:model-account.move>` from the `Commission
|
||||
<commission:model-commission>` lines when it is posted.
|
||||
|
||||
.. seealso::
|
||||
|
||||
The `Invoice <account_invoice:model-account.invoice>` concept is introduced
|
||||
by the :doc:`Account Invoice Module <account_invoice:index>`.
|
||||
@@ -1,9 +1,15 @@
|
||||
Commission Waiting
|
||||
##################
|
||||
#########################
|
||||
Commission Waiting Module
|
||||
#########################
|
||||
|
||||
The commission_waiting module allows to generate account move for each
|
||||
commission between the expense/revenue account to a waiting account defined on
|
||||
The *Commission Waiting Module* allows an account move to be generated for each
|
||||
commission between the expense/revenue account and a waiting account defined on
|
||||
the agent.
|
||||
|
||||
Once the commission invoice is posted the waiting account is cleared with the
|
||||
When the commission invoice is posted the waiting account is cleared using the
|
||||
payable/receivable account of the invoice.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
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):
|
||||
@@ -59,7 +62,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-commission-waiting'),
|
||||
"Forum": 'https://www.tryton.org/forum',
|
||||
"Source Code": 'https://code.tryton.org/tryton',
|
||||
},
|
||||
|
||||
Reference in New Issue
Block a user