diff --git a/modules/dashboard/CHANGELOG b/modules/dashboard/CHANGELOG index 57e17b52f6..4d3948011c 100644 --- a/modules/dashboard/CHANGELOG +++ b/modules/dashboard/CHANGELOG @@ -20,85 +20,113 @@ 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 + 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) * Filter action based on usage "dashboard" 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-26 +-------------------------- * Bug fixes (see mercurial logs for details) Version 1.8.0 - 2010-11-01 +-------------------------- * Bug fixes (see mercurial logs for details) * Remove required on dashboard_layout to allow XML user creation Version 1.6.0 - 2010-05-09 +-------------------------- * Bug fixes (see mercurial logs for details) Version 1.4.0 - 2010-03-11 +-------------------------- * Initial release diff --git a/modules/dashboard/doc/design.rst b/modules/dashboard/doc/design.rst new file mode 100644 index 0000000000..4fdbf458e9 --- /dev/null +++ b/modules/dashboard/doc/design.rst @@ -0,0 +1,31 @@ +****** +Design +****** + +The *Dashboard Module* introduces or extends the following concepts: + +.. _model-dashboard.action: + +Dashboard Action +================ + +The *Dashboard Action* links a `Window Action +` to a `User `. + +.. note:: + To be used a window action must have the :guilabel:`Usage` set to + ``dashboard``. + +.. _model-res.user: + +User +==== + +When the *Dashboard Module* is activated, the *User* gains new properties to +allow them to define the layout and the actions to be displayed by the +dashboard. + +.. seealso:: + + The `User ` concept is introduced by the + :ref:`Resource Module `. diff --git a/modules/dashboard/doc/index.rst b/modules/dashboard/doc/index.rst index 30490dd476..d02d712508 100644 --- a/modules/dashboard/doc/index.rst +++ b/modules/dashboard/doc/index.rst @@ -1,4 +1,12 @@ +################ Dashboard Module ################ -The dashboard module allows user to configure his dashboard. +The *Dashboard Module* allows each user to configure a personal dashboard. + +.. toctree:: + :maxdepth: 2 + + usage + design + releases diff --git a/modules/dashboard/doc/releases.rst b/modules/dashboard/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/dashboard/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/dashboard/doc/usage.rst b/modules/dashboard/doc/usage.rst new file mode 100644 index 0000000000..ff9d6f9718 --- /dev/null +++ b/modules/dashboard/doc/usage.rst @@ -0,0 +1,14 @@ +***** +Usage +***** + +.. _Open dashboard on login: + +Open dashboard on login +======================= + +It is possible to have the dashboard open each time you login to Tryton. +You must first define some `Dashboard Actions ` in your +preferences and then select the :guilabel:`Dashboard` in the +:guilabel:`Actions` list. +Now each time you login to Tryton, your personal dashboard is displayed. diff --git a/modules/dashboard/setup.py b/modules/dashboard/setup.py index e7a31f91e5..0ef2ebbceb 100755 --- a/modules/dashboard/setup.py +++ b/modules/dashboard/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-dashboard', "Forum": 'https://www.tryton.org/forum', "Source Code": 'https://code.tryton.org/tryton', },