From 710ec4a136c45e954d7614f9730ff61bc3841699 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Mon, 26 Aug 2024 22:06:16 +0200 Subject: [PATCH] Update documentation of party SIRET --- modules/party_siret/CHANGELOG | 27 +++++++++++++++++++++ modules/party_siret/doc/design.rst | 35 ++++++++++++++++++++++++++++ modules/party_siret/doc/index.rst | 11 ++++++++- modules/party_siret/doc/releases.rst | 7 ++++++ modules/party_siret/setup.py | 7 ++++-- 5 files changed, 84 insertions(+), 3 deletions(-) create mode 100644 modules/party_siret/doc/design.rst create mode 100644 modules/party_siret/doc/releases.rst diff --git a/modules/party_siret/CHANGELOG b/modules/party_siret/CHANGELOG index dee5f24d84..d591ee8a73 100644 --- a/modules/party_siret/CHANGELOG +++ b/modules/party_siret/CHANGELOG @@ -21,85 +21,112 @@ 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) * Use party identifier to store SIREN and SIRET * 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 + 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-24 +-------------------------- * 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-11 +-------------------------- * Bug fixes (see mercurial logs for details) Version 1.4.0 - 2010-03-11 +-------------------------- * Initial release diff --git a/modules/party_siret/doc/design.rst b/modules/party_siret/doc/design.rst new file mode 100644 index 0000000000..4c085458af --- /dev/null +++ b/modules/party_siret/doc/design.rst @@ -0,0 +1,35 @@ +****** +Design +****** + +The *Party SIRET Module* extends the following concepts: + +.. _model-party.party: + +Party +===== + +When the *Party SIRET Module* is activated, parties gain a property that +calculates the `SIREN code `_ based +on the `Identifier ` with the type +:guilabel:`French Company Identification Number`. + +.. seealso:: + + The `Party ` concept is introduced by the + :doc:`Party Module `. + +.. _model-party.address: + +Address +======= + +When the *Party SIRET Module* is activated, addresses gain a property that +calculates the `SIRET code `_ based +on the `Identifier ` with the type +:guilabel:`French Company Establishment Identification Number`. + +.. seealso:: + + The `Address ` concept is introduced by the + :doc:`Party Module `. diff --git a/modules/party_siret/doc/index.rst b/modules/party_siret/doc/index.rst index 3c7587509a..a2719fc824 100644 --- a/modules/party_siret/doc/index.rst +++ b/modules/party_siret/doc/index.rst @@ -1,4 +1,13 @@ +################## Party SIRET Module ################## -The party siret module adds the SIREN and SIRET on party and address. +The *Party SIRET Module* adds a `SIREN code +`_ to party and `SIRET code +`_ to address. + +.. toctree:: + :maxdepth: 2 + + design + releases diff --git a/modules/party_siret/doc/releases.rst b/modules/party_siret/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/party_siret/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/party_siret/setup.py b/modules/party_siret/setup.py index 4e44f4cbed..eb0853d251 100755 --- a/modules/party_siret/setup.py +++ b/modules/party_siret/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): @@ -57,7 +60,7 @@ 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-party-siret', "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://code.tryton.org/tryton', },