From ed6e62d396e5c27c04503347c9b8dddc6248811c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Tue, 15 Oct 2024 16:28:03 +0000 Subject: [PATCH] Update documentation of company work time --- modules/company_work_time/CHANGELOG | 27 ++++++++++++++++++++++ modules/company_work_time/doc/design.rst | 18 +++++++++++++++ modules/company_work_time/doc/index.rst | 13 +++++++---- modules/company_work_time/doc/releases.rst | 7 ++++++ modules/company_work_time/setup.py | 8 +++++-- 5 files changed, 67 insertions(+), 6 deletions(-) create mode 100644 modules/company_work_time/doc/design.rst create mode 100644 modules/company_work_time/doc/releases.rst diff --git a/modules/company_work_time/CHANGELOG b/modules/company_work_time/CHANGELOG index e44149afbe..9dfe681073 100644 --- a/modules/company_work_time/CHANGELOG +++ b/modules/company_work_time/CHANGELOG @@ -20,85 +20,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) * 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) * Make hours per work optional 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-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-11 +-------------------------- * Bug fixes (see mercurial logs for details) Version 1.4.0 - 2009-10-19 +-------------------------- * Initial release diff --git a/modules/company_work_time/doc/design.rst b/modules/company_work_time/doc/design.rst new file mode 100644 index 0000000000..eabff18d82 --- /dev/null +++ b/modules/company_work_time/doc/design.rst @@ -0,0 +1,18 @@ +****** +Design +****** + +The *Company Work Time Module* extends the following concepts: + +.. _model-company.company: + +Company +======= + +The *Company* gains new properties which are used to define the number of hours +in a work day, week, month and year for each company. + +.. seealso:: + + The `Company ` concept is introduced by the + :doc:`Company Module `. diff --git a/modules/company_work_time/doc/index.rst b/modules/company_work_time/doc/index.rst index 677f02f6c3..8f825a0a0f 100644 --- a/modules/company_work_time/doc/index.rst +++ b/modules/company_work_time/doc/index.rst @@ -1,7 +1,12 @@ +######################## Company Work Time Module ######################## -The Company Work Time module adds 4 new fields (Hours per Work Day, -Hours per Work Week, Hours per Work Month, Hours per Work Year) on the -company form that allow to define how much hours are spent by an -employee in a day, a week, a month and a year of work. +The *Company Work Time Module* allows companies to define how long a work day, +week and month is. + +.. toctree:: + :maxdepth: 2 + + design + releases diff --git a/modules/company_work_time/doc/releases.rst b/modules/company_work_time/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/company_work_time/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/company_work_time/setup.py b/modules/company_work_time/setup.py index 60780d65d0..d0e9fec673 100755 --- a/modules/company_work_time/setup.py +++ b/modules/company_work_time/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,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-company-work-time'), "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://code.tryton.org/tryton', },