diff --git a/modules/analytic_account/CHANGELOG b/modules/analytic_account/CHANGELOG index 071c04caa9..4751e9342a 100644 --- a/modules/analytic_account/CHANGELOG +++ b/modules/analytic_account/CHANGELOG @@ -21,30 +21,37 @@ Version 6.6.0 - 2022-10-31 * Use context model for chart of analytic accounts 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 * Ignore balance of non-deferral move * Add a button to manually reapply rule engine Version 5.6.0 - 2020-05-04 +-------------------------- * Bug fixes (see mercurial logs for details) * Use move line date by default when created by rule engine 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) * Remove display balance * Apply rules only on income statement lines @@ -52,20 +59,25 @@ Version 5.2.0 - 2019-05-06 * Remove positive constraint on debit/credit 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) * Add rule engine Version 4.2.0 - 2016-11-28 +-------------------------- * Bug fixes (see mercurial logs for details) * Add get_analytic_lines on AnalyticAccountEntry * Add distribution account type @@ -77,57 +89,73 @@ Version 4.2.0 - 2016-11-28 * Enforce company consistency 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 * Use One2Many for analytic accounts 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-23 +-------------------------- * Bug fixes (see mercurial logs for details) Version 2.2.0 - 2011-10-24 +-------------------------- * Bug fixes (see mercurial logs for details) 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) * Remove egenix-mx-base Version 1.4.0 - 2009-10-19 +-------------------------- * Bug fixes (see mercurial logs for details) * Convert currency on line into Function field * Use digits of currency for debit and credit * Use the right currency to compute balance, debit/credit of accounts Version 1.2.0 - 2009-04-20 +-------------------------- * Bug fixes (see mercurial logs for details) * Allow egg installation Version 1.0.0 - 2008-11-17 +-------------------------- * Initial release diff --git a/modules/analytic_account/doc/design.rst b/modules/analytic_account/doc/design.rst new file mode 100644 index 0000000000..6f9c109de2 --- /dev/null +++ b/modules/analytic_account/doc/design.rst @@ -0,0 +1,80 @@ +****** +Design +****** + +The *Analytic Account Module* introduces and extends the following concepts: + +.. _model-analytic_account.account: + +Analytic Account +================ + +The *Analytic Account* is used to represent the various analytical axes. +The *Analytic Accounts* are organized in a tree structure, with each root +defining an axis. + +Only the *Analytic Accounts* of type :guilabel:`Normal` can be used with the +`Analytic Lines `. + +If an *Analytic Account* of the type :guilabel:`Distribution` is used in an +entry, an analytic line is created for each distribution line with an amount +proportional to its ratio and its *Analytic Account*. + +.. seealso:: + + The *Analytic Account* can be found by opening the main menu item: + + |Financial --> Configuration --> Analytic --> Accounts|__ + + .. |Financial --> Configuration --> Analytic --> Accounts| replace:: :menuselection:`Financial --> Configuration --> Analytic --> Accounts` + __ https://demo.tryton.org/model/analytic_account.account + +.. _model-analytic_account.line: + +Analytic Line +============= + +The *Analytic Line* defines the amount from an `Account Move Line +` to be allocated to an `Analytic Account +`. + +.. _model-account.move.line: + +Account Move Line +================= + +When the *Analytic Account Module* is activated, the *Account Move Line* gains +an :guilabel:`Analytic State` which is updated when the linked `Account Move +` is posted. +The :guilabel:`Analytic State` is valid only if all the `Analytic Account +` axes are completely filled. + +.. seealso:: + + The incomplete *Account Move Line* can be found by opening the main menu + item: + + |Financial --> Processing --> Analytic Lines to Complete|__ + + .. |Financial --> Processing --> Analytic Lines to Complete| replace:: :menuselection:`Financial --> Processing --> Analytic Lines to Complete` + __ https://demo.tryton.org/model/account.move.line;domain=[["analytic_state"%2C"%3D"%2C"draft"]%2C["move_state"%2C"%3D"%2C"posted"]] + +.. _model-analytic_account.rule: + +Analytic Rule +============= + +The *Analytic Rule* defines criteria such as `Account +` and `Journal ` +to automatically populate the empty `Analytic Lines +` for a posted `Account Move +`. + +.. seealso:: + + The *Analytic Rules* can be found by opening the main menu item: + + |Financial --> Configuration --> Analytic --> Rules|__ + + .. |Financial --> Configuration --> Analytic --> Rules| replace:: :menuselection:`Financial --> Configuration --> Analytic --> Rules` + __ https://demo.tryton.org/model/analytic_account.rule diff --git a/modules/analytic_account/doc/index.rst b/modules/analytic_account/doc/index.rst index b5ed4b6770..3b83ea3f48 100644 --- a/modules/analytic_account/doc/index.rst +++ b/modules/analytic_account/doc/index.rst @@ -1,60 +1,12 @@ +####################### Analytic Account Module ####################### -The analytic account module adds the fundamentals required to analyse +The *Analytic Account Module* adds the fundamentals required to analyse accounting using multiple different axes. -A chart of analytic accounts can be setup for each axis. +.. toctree:: + :maxdepth: 2 -Account -******* - -An analytic account is defined by these fields: - -- Name -- Code -- Company -- Type: - - - Root: define an axis - - View: sum amounts of children accounts - - Normal: store analytic lines - - Distribution: distribute linked lines between different accounts - -- Parent -- Balance/Credit/Debit -- State: - - - Draft - - Opened - - Closed - -- Note - -Line -**** - -An analytic line defines the amount of money from a move line to be assigned to -an analytic account. It contains the following fields: - -- Debit/Credit -- Account -- Move Line -- Date - -When the linked move is posted, an analytic state is calculated for each of the -move lines. It is only valid if all the analytic axes have been completely -filled. -The incomplete lines can be found in the menu entry "Analytic Lines to -Complete". - -Rule -**** - -The module contains a rule engine that can automatically create analytic lines -when the move is posted, but only if they do not already have analytic lines. -The criteria for the rule engine are: - -- Account -- Party -- Journal + design + releases diff --git a/modules/analytic_account/doc/releases.rst b/modules/analytic_account/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/analytic_account/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/analytic_account/setup.py b/modules/analytic_account/setup.py index f888a3b8dc..3ae0962ec5 100755 --- a/modules/analytic_account/setup.py +++ b/modules/analytic_account/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): @@ -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-analytic-account'), "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://code.tryton.org/tryton', },