From 92089ba47dd8d4086a7ea95a03ab38252c46a390 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Thu, 27 Oct 2022 13:24:22 +0200 Subject: [PATCH] Publish changelog in the documentation issue11805 review431781003 --- CHANGELOG | 24 ++++++++++++++++++++++++ doc/index.rst | 5 +++++ doc/releases.rst | 7 +++++++ setup.py | 9 ++++++++- 4 files changed, 44 insertions(+), 1 deletion(-) create mode 100644 doc/releases.rst diff --git a/CHANGELOG b/CHANGELOG index fca5fff1af..3c978ef6d7 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,4 +1,5 @@ Version 6.4.0 - 2022-05-02 +-------------------------- * Bug fixes (see mercurial logs for details) * Use unittest discover * Support notification message @@ -7,66 +8,80 @@ Version 6.4.0 - 2022-05-02 * Remove support for Python 3.6 Version 6.2.0 - 2021-11-01 +-------------------------- * Bug fixes (see mercurial logs for details) * Support session with XML-RPC * Use bigdecimal tag for XML-RPC Version 6.0.0 - 2021-05-03 +-------------------------- * Bug fixes (see mercurial logs for details) * Add support for Python 3.9 * Unify PYSON string format Version 5.8.0 - 2020-11-02 +-------------------------- * Bug fixes (see mercurial logs for details) * Remove support for Python 3.5 * Support PYSON comparison of date and datetime Version 5.6.0 - 2020-05-04 +-------------------------- * Bug fixes (see mercurial logs for details) * Add support for Python 3.8 * Use same __str__ as trytond instances Version 5.4.0 - 2019-11-04 +-------------------------- * Bug fixes (see mercurial logs for details) * Support dot notation on PYSON Eval * Add __slots__ Version 5.2.0 - 2019-05-06 +-------------------------- * Bug fixes (see mercurial logs for details) * Remove support for Python 3.4 Version 5.0.0 - 2018-10-01 +-------------------------- * Bug fixes (see mercurial logs for details) * Add support for Python 3.7 * Remove support for Python 2.7 Version 4.8.0 - 2018-04-23 +-------------------------- * Bug fixes (see mercurial logs for details) * Always use the context and config of the instance * Add support for search_* attributes in ModelList Version 4.6.0 - 2017-10-30 +-------------------------- * Bug fixes (see mercurial logs for details) * Add set_sequence method to ModelList * Add __int__ to Model * Allow to use keyword arguments with trytond configuration 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) * Fill default Report data 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) * Add StateAction support to Wizard Version 3.6.0 - 2015-04-20 +-------------------------- * Bug fixes (see mercurial logs for details) * Add support for PyPy * Allow to provide extra keyword arguments to set_xmlrpc() @@ -75,6 +90,7 @@ Version 3.6.0 - 2015-04-20 * Manage reload, save, delete, duplicate and click as class and instance method Version 3.4.0 - 2014-10-20 +-------------------------- * Bug fixes (see mercurial logs for details) * New configuration syntax * Add Report @@ -82,6 +98,7 @@ Version 3.4.0 - 2014-10-20 * Add duplicate method Version 3.2.0 - 2014-04-21 +-------------------------- * Bug fixes (see mercurial logs for details) * Models cache depends also on user * Drop support of Python 2.6 @@ -89,29 +106,36 @@ Version 3.2.0 - 2014-04-21 * Add click method for buttons 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) * Add support of fields.Dict 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) * Use loading attribute * Add support of _buttons * Add support of fields.Time Version 2.2.0 - 2011-10-25 +-------------------------- * Bug fixes (see mercurial logs for details) * Change license to LGPL-3 * Drop support of Python 2.5 Version 2.0.0 - 2011-04-28 +-------------------------- * Bug fixes (see mercurial logs for details) * Manage default values of trytond configuration Version 1.8.0 - 2010-12-24 +-------------------------- * Initial release diff --git a/doc/index.rst b/doc/index.rst index f2827b041e..8844fee067 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -164,3 +164,8 @@ Read in French: >>> category_fr.reload() >>> category_fr.name 'Categorie' + +.. toctree:: + :maxdepth: 2 + + releases diff --git a/doc/releases.rst b/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/setup.py b/setup.py index 17608fc23c..fa3ca38484 100755 --- a/setup.py +++ b/setup.py @@ -14,6 +14,13 @@ def read(fname): 'r', encoding='utf-8').read() +def readme(): + content = read('README.rst') + content = re.sub( + r'(?m)^\.\. toctree::\r?\n((^$|^\s.*$)\r?\n)*', '', content) + return content + + def get_version(): init = read(os.path.join('proteus', '__init__.py')) return re.search('__version__ = "([0-9.]*)"', init).group(1) @@ -63,7 +70,7 @@ if minor_version % 2: setup(name=name, version=version, description='Library to access Tryton server as a client', - long_description=read('README.rst'), + long_description=readme(), author='Tryton', author_email='bugs@tryton.org', url='http://www.tryton.org/',