From 7eab401995bf08e031fa147e0b2ef6d5ca7e2eb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Fri, 2 Aug 2024 10:15:25 +0200 Subject: [PATCH] Update documentation of analytic sale --- modules/analytic_sale/CHANGELOG | 28 ++++++++++++++++++++++++++ modules/analytic_sale/doc/design.rst | 21 +++++++++++++++++++ modules/analytic_sale/doc/index.rst | 9 ++++++++- modules/analytic_sale/doc/releases.rst | 7 +++++++ modules/analytic_sale/setup.py | 8 ++++++-- 5 files changed, 70 insertions(+), 3 deletions(-) create mode 100644 modules/analytic_sale/doc/design.rst create mode 100644 modules/analytic_sale/doc/releases.rst diff --git a/modules/analytic_sale/CHANGELOG b/modules/analytic_sale/CHANGELOG index 27a9f50331..84c45a17ef 100644 --- a/modules/analytic_sale/CHANGELOG +++ b/modules/analytic_sale/CHANGELOG @@ -20,93 +20,121 @@ 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 +-------------------------- * 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-13 +-------------------------- * Bug fixes (see mercurial logs for details) Version 1.4.0 - 2009-10-19 +-------------------------- * Bug fixes (see mercurial logs for details) 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_sale/doc/design.rst b/modules/analytic_sale/doc/design.rst new file mode 100644 index 0000000000..7d2729e15b --- /dev/null +++ b/modules/analytic_sale/doc/design.rst @@ -0,0 +1,21 @@ +****** +Design +****** + +The *Analytic Sale Module* extends the following concepts: + +.. _model-sale.sale: + +Sale +==== + +When the *Analytic Sale Module* is activated, the *Sale* line gains a +new property to set one `Analytic Account +` per axis. +These analytic accounts are transferred to the generated `Invoice +` lines. + +.. seealso:: + + The `Sale ` concept is introduced by the :doc:`Sale + Module `. diff --git a/modules/analytic_sale/doc/index.rst b/modules/analytic_sale/doc/index.rst index 2d9f02e820..8b2a5265ab 100644 --- a/modules/analytic_sale/doc/index.rst +++ b/modules/analytic_sale/doc/index.rst @@ -1,4 +1,11 @@ +#################### Analytic Sale Module #################### -The analytic sale module allows to set analytic accounts on sale line. +The *Analytic Sale Module* adds analytic accounts to the sale lines. + +.. toctree:: + :maxdepth: 2 + + design + releases diff --git a/modules/analytic_sale/doc/releases.rst b/modules/analytic_sale/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/analytic_sale/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/analytic_sale/setup.py b/modules/analytic_sale/setup.py index ec60a32613..be6c7189ad 100755 --- a/modules/analytic_sale/setup.py +++ b/modules/analytic_sale/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-sale'), "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://code.tryton.org/tryton', },