Merge pull request #139 from ds-wizard/release/4.5.0

Release 4.5.0
ds-wizard · Apr 2, 2024 · 1828dc6 · 1828dc6
2 parents d094f49 + a8d2d1a
commit 1828dc6
Show file tree

Hide file tree

Showing 86 changed files with 57 additions and 50 deletions.
diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml
@@ -13,7 +13,6 @@ jobs:
       matrix:
         format:
           - html
-          - epub
           - latex
 
     steps:
@@ -23,7 +22,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: 3.11
+          python-version: 3.12
           cache: pip
           cache-dependency-path: |
             **/requirements*.txt

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -5,12 +5,14 @@ version: 2
 sphinx:
   configuration: docs/conf.py
 
-formats: all
+formats:
+  - htmlzip
+  - pdf
 
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.11"
+    python: "3.12"
 
 python:
   install:

diff --git a/docs/about/introduction/knowledge-model.rst b/docs/about/introduction/knowledge-model.rst
@@ -94,7 +94,7 @@ If the desired answer is not present in the external resource, users can still f
 Multi-Choice Question
 ^^^^^^^^^^^^^^^^^^^^^
 
-The mutli-choice question has a list of :ref:`choices<choice>`. Users can then pick as many of those choices as they wish. There are, however, no follow-up questions available for this question type.
+The multi-choice question has a list of :ref:`choices<choice>`. Users can then pick as many of those choices as they wish. There are, however, no follow-up questions available for this question type.
 
 
 .. _answer:
@@ -117,7 +117,7 @@ If there are some :ref:`metrics<metric>` created in the knowledge model, we can
 Choice
 ------
 
-A choice is used with :ref:`mutli-choice questions<multi-choice-question>`. It only contains a **label** which is presented to the user.
+A choice is used with :ref:`multi-choice questions<multi-choice-question>`. It only contains a **label** which is presented to the user.
 
 
 .. _reference:
@@ -169,6 +169,7 @@ This can be use, for example, to define the FAIR metrics:
 
 And then define which answers affect which FAIR metrics to provide more feedback to the researchers.
 
+How answer affect certain metric is then set up in the :ref:`answer<answer>`.
 
 
 .. _phase:

diff --git a/docs/application/administration/locales/detail/detail.png b/docs/application/administration/locales/detail/detail.png
diff --git a/docs/application/administration/locales/import/file.png b/docs/application/administration/locales/import/file.png
diff --git a/docs/application/administration/locales/import/registry.png b/docs/application/administration/locales/import/registry.png
diff --git a/docs/application/administration/locales/index/list.png b/docs/application/administration/locales/index/list.png
diff --git a/docs/application/administration/settings/info/usage/usage.png b/docs/application/administration/settings/info/usage/usage.png
diff --git a/docs/application/administration/settings/system/authentication/openid.png b/docs/application/administration/settings/system/authentication/openid.png
diff --git a/...plication/administration/settings/user-interface/look-and-feel/custom-links.png b/...plication/administration/settings/user-interface/look-and-feel/custom-links.png
diff --git a/docs/application/administration/users/detail/password.png b/docs/application/administration/users/detail/password.png
diff --git a/docs/application/administration/users/index/list.png b/docs/application/administration/users/index/list.png
diff --git a/docs/application/document-templates/editors/create/create-document-template.png b/docs/application/document-templates/editors/create/create-document-template.png
diff --git a/docs/application/document-templates/editors/detail/files/files.png b/docs/application/document-templates/editors/detail/files/files.png
diff --git a/docs/application/document-templates/editors/detail/index/editor.png b/docs/application/document-templates/editors/detail/index/editor.png
diff --git a/docs/application/document-templates/editors/detail/preview/preview.png b/docs/application/document-templates/editors/detail/preview/preview.png
diff --git a/docs/application/document-templates/editors/detail/publish/modal.png b/docs/application/document-templates/editors/detail/publish/modal.png
diff --git a/docs/application/document-templates/editors/detail/template/allowed-kms.png b/docs/application/document-templates/editors/detail/template/allowed-kms.png
diff --git a/docs/application/document-templates/editors/detail/template/formats.png b/docs/application/document-templates/editors/detail/template/formats.png
diff --git a/docs/application/document-templates/editors/index/list.png b/docs/application/document-templates/editors/index/list.png
diff --git a/docs/application/document-templates/list/detail/detail.png b/docs/application/document-templates/list/detail/detail.png
diff --git a/docs/application/document-templates/list/import/file.png b/docs/application/document-templates/list/import/file.png
diff --git a/docs/application/document-templates/list/import/registry.png b/docs/application/document-templates/list/import/registry.png
diff --git a/docs/application/document-templates/list/index/list.png b/docs/application/document-templates/list/index/list.png
diff --git a/docs/application/documents/index/list.png b/docs/application/documents/index/list.png
diff --git a/docs/application/knowledge-models/editors/create/create-km.png b/docs/application/knowledge-models/editors/create/create-km.png
diff --git a/docs/application/knowledge-models/editors/detail/index/km-editor.png b/docs/application/knowledge-models/editors/detail/index/km-editor.png
diff --git a/...ation/knowledge-models/editors/detail/knowledge-model/editor-action-buttons.png b/...ation/knowledge-models/editors/detail/knowledge-model/editor-action-buttons.png
diff --git a/docs/application/knowledge-models/editors/detail/knowledge-model/editor-form.png b/docs/application/knowledge-models/editors/detail/knowledge-model/editor-form.png
diff --git a/docs/application/knowledge-models/editors/detail/knowledge-model/navigation.png b/docs/application/knowledge-models/editors/detail/knowledge-model/navigation.png
diff --git a/docs/application/knowledge-models/editors/detail/knowledge-model/warnings.png b/docs/application/knowledge-models/editors/detail/knowledge-model/warnings.png
diff --git a/docs/application/knowledge-models/editors/detail/phases/phases-editor.png b/docs/application/knowledge-models/editors/detail/phases/phases-editor.png
diff --git a/docs/application/knowledge-models/editors/detail/preview/preview.png b/docs/application/knowledge-models/editors/detail/preview/preview.png
diff --git a/docs/application/knowledge-models/editors/detail/publish/publish-modal.png b/docs/application/knowledge-models/editors/detail/publish/publish-modal.png
diff --git a/...plication/knowledge-models/editors/detail/question-tags/question-tag-editor.png b/...plication/knowledge-models/editors/detail/question-tags/question-tag-editor.png
diff --git a/docs/application/knowledge-models/editors/detail/settings/settings-form.png b/docs/application/knowledge-models/editors/detail/settings/settings-form.png
diff --git a/docs/application/knowledge-models/editors/index/knowledge-model-editors-list.png b/docs/application/knowledge-models/editors/index/knowledge-model-editors-list.png
diff --git a/docs/application/knowledge-models/editors/migration/create-migration-modal.png b/docs/application/knowledge-models/editors/migration/create-migration-modal.png
diff --git a/docs/application/knowledge-models/editors/migration/migration.png b/docs/application/knowledge-models/editors/migration/migration.png
diff --git a/docs/application/knowledge-models/editors/migration/update-available.png b/docs/application/knowledge-models/editors/migration/update-available.png
diff --git a/docs/application/knowledge-models/list/detail/detail.png b/docs/application/knowledge-models/list/detail/detail.png
diff --git a/docs/application/knowledge-models/list/import/file.png b/docs/application/knowledge-models/list/import/file.png
diff --git a/docs/application/knowledge-models/list/import/registry.png b/docs/application/knowledge-models/list/import/registry.png
diff --git a/docs/application/knowledge-models/list/index/list.png b/docs/application/knowledge-models/list/index/list.png
diff --git a/docs/application/profile/edit/active-sessions/form.png b/docs/application/profile/edit/active-sessions/form.png
diff --git a/docs/application/profile/edit/api-keys/form.png b/docs/application/profile/edit/api-keys/form.png
diff --git a/docs/application/profile/edit/index/form.png b/docs/application/profile/edit/index/form.png
diff --git a/docs/application/profile/edit/password/form.png b/docs/application/profile/edit/password/form.png
diff --git a/docs/application/profile/index/menu.png b/docs/application/profile/index/menu.png
diff --git a/docs/application/profile/language/modal.png b/docs/application/profile/language/modal.png
diff --git a/docs/application/projects/importers/importers.png b/docs/application/projects/importers/importers.png
diff --git a/docs/application/projects/list/create/project-create-custom.png b/docs/application/projects/list/create/project-create-custom.png
diff --git a/docs/application/projects/list/create/project-create.png b/docs/application/projects/list/create/project-create.png
diff --git a/docs/application/projects/list/detail/documents/list.png b/docs/application/projects/list/detail/documents/list.png
diff --git a/docs/application/projects/list/detail/documents/new.png b/docs/application/projects/list/detail/documents/new.png
diff --git a/docs/application/projects/list/detail/documents/submission.png b/docs/application/projects/list/detail/documents/submission.png
diff --git a/docs/application/projects/list/detail/index/questionnaire.png b/docs/application/projects/list/detail/index/questionnaire.png
diff --git a/docs/application/projects/list/detail/metrics/metrics.png b/docs/application/projects/list/detail/metrics/metrics.png
diff --git a/docs/application/projects/list/detail/preview/document-template-not-set.png b/docs/application/projects/list/detail/preview/document-template-not-set.png
diff --git a/docs/application/projects/list/detail/preview/download.png b/docs/application/projects/list/detail/preview/download.png
diff --git a/docs/application/projects/list/detail/preview/preview-html.png b/docs/application/projects/list/detail/preview/preview-html.png
diff --git a/docs/application/projects/list/detail/questionnaire.rst b/docs/application/projects/list/detail/questionnaire.rst
@@ -138,7 +138,7 @@ Multi-Choice Question
 
 Multi-choice question is similar to the options question, however we can choose more there one answer and there are no follow-up questions.
 
-.. figure:: questionnaire/mutli-choice-question.png
+.. figure:: questionnaire/multi-choice-question.png
 
     Multi-choice question with many choices.
 

diff --git a/docs/application/projects/list/detail/questionnaire/chapter-list.png b/docs/application/projects/list/detail/questionnaire/chapter-list.png
diff --git a/docs/application/projects/list/detail/questionnaire/comments.png b/docs/application/projects/list/detail/questionnaire/comments.png
diff --git a/docs/application/projects/list/detail/questionnaire/integration-question.png b/docs/application/projects/list/detail/questionnaire/integration-question.png
diff --git a/docs/application/projects/list/detail/questionnaire/list-question.png b/docs/application/projects/list/detail/questionnaire/list-question.png
diff --git a/docs/application/projects/list/detail/questionnaire/multi-choice-question.png b/docs/application/projects/list/detail/questionnaire/multi-choice-question.png
diff --git a/docs/application/projects/list/detail/questionnaire/mutli-choice-question.png b/docs/application/projects/list/detail/questionnaire/mutli-choice-question.png
diff --git a/docs/application/projects/list/detail/questionnaire/options-question.png b/docs/application/projects/list/detail/questionnaire/options-question.png
diff --git a/docs/application/projects/list/detail/questionnaire/phase-selection-modal.png b/docs/application/projects/list/detail/questionnaire/phase-selection-modal.png
diff --git a/docs/application/projects/list/detail/questionnaire/phase-selection.png b/docs/application/projects/list/detail/questionnaire/phase-selection.png
diff --git a/docs/application/projects/list/detail/questionnaire/todos.png b/docs/application/projects/list/detail/questionnaire/todos.png
diff --git a/docs/application/projects/list/detail/questionnaire/value-question.png b/docs/application/projects/list/detail/questionnaire/value-question.png
diff --git a/docs/application/projects/list/detail/questionnaire/version-history.png b/docs/application/projects/list/detail/questionnaire/version-history.png
diff --git a/docs/application/projects/list/detail/questionnaire/view-options.png b/docs/application/projects/list/detail/questionnaire/view-options.png
diff --git a/docs/application/projects/list/detail/questionnaire/warnings.png b/docs/application/projects/list/detail/questionnaire/warnings.png
diff --git a/docs/application/projects/list/detail/settings/settings.png b/docs/application/projects/list/detail/settings/settings.png
diff --git a/docs/application/projects/list/detail/sharing/share-modal.png b/docs/application/projects/list/detail/sharing/share-modal.png
diff --git a/docs/application/projects/list/index.rst b/docs/application/projects/list/index.rst
@@ -28,6 +28,7 @@ We can :ref:`create a new project<create-project>` by clicking the :guilabel:`Cr
 By clicking the triple dots on each of the item in the list we can access some actions:
 
 - **Open project** - will simply open the project
+- **Create project from this template** - will create a new project from the selected project template (this is only available if the project is also a project template)
 - **Clone** - will create the exact copy of the project
 - **Create migration** - will start a :ref:`project migration<project-migration>`
 - **Delete** - will delete the project (this action cannot be undone)

diff --git a/docs/application/projects/list/index/project-list.png b/docs/application/projects/list/index/project-list.png
diff --git a/docs/application/projects/list/migration/create.png b/docs/application/projects/list/migration/create.png
diff --git a/docs/application/projects/list/migration/migration.png b/docs/application/projects/list/migration/migration.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -25,7 +25,7 @@
 project_name_full = 'Data Stewardship Wizard'
 
 # The full version, including alpha/beta/rc tags
-version = release = '4.4'
+version = release = '4.5'
 
 rst_prolog = f"""
 

diff --git a/docs/more/miscellaneous/dsw-registry/dsw-registry.png b/docs/more/miscellaneous/dsw-registry/dsw-registry.png
diff --git a/docs/more/self-hosted-dsw/upgrade-guidelines.rst b/docs/more/self-hosted-dsw/upgrade-guidelines.rst
@@ -43,6 +43,11 @@ Usually, nothing special is required for the upgrade. Internal structure changes
 
    Make sure to stop ``document-worker`` and ``mailer`` before upgrading to the next version. Run ``wizard-server`` first, then run the workers. Otherwise the database migrations might not work correctly.
 
+4.4.X to 4.5.X
+----------------
+
+*(nothing)*
+
 4.3.X to 4.4.X
 ----------------
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,52 +1,51 @@
-alabaster==0.7.13
-apeye==1.4.0
-apeye-core==1.1.4
-autodocsumm==0.2.11
-Babel==2.12.1
-beautifulsoup4==4.12.2
-CacheControl==0.13.1
-certifi==2023.5.7
-charset-normalizer==3.2.0
-cssutils==2.7.1
-dict2css==0.3.0
-docutils==0.18.1
-domdf-python-tools==3.6.1
-filelock==3.12.2
-furo==2023.5.20
+alabaster==0.7.16
+apeye==1.4.1
+apeye-core==1.1.5
+autodocsumm==0.2.12
+Babel==2.14.0
+beautifulsoup4==4.12.3
+CacheControl==0.14.0
+certifi==2024.2.2
+charset-normalizer==3.3.2
+cssutils==2.9.0
+dict2css==0.3.0.post1
+docutils==0.20.1
+domdf-python-tools==3.8.0.post2
+filelock==3.13.3
+furo==2024.1.29
 html5lib==1.1
-idna==3.4
+idna==3.6
 imagesize==1.4.1
-Jinja2==3.1.2
-lockfile==0.12.2
-MarkupSafe==2.1.3
-msgpack==1.0.5
+Jinja2==3.1.3
+MarkupSafe==2.1.5
+msgpack==1.0.8
 natsort==8.4.0
-packaging==23.1
-platformdirs==3.9.1
-Pygments==2.15.1
+packaging==24.0
+platformdirs==4.2.0
+Pygments==2.17.2
 requests==2.31.0
-ruamel.yaml==0.17.32
-ruamel.yaml.clib==0.2.7
+ruamel.yaml==0.18.6
+ruamel.yaml.clib==0.2.8
 six==1.16.0
 snowballstemmer==2.2.0
-soupsieve==2.4.1
-Sphinx==7.0.1
-sphinx-autodoc-typehints==1.23.3
+soupsieve==2.5
+Sphinx==7.2.6
+sphinx-autodoc-typehints==2.0.0
 sphinx-basic-ng==1.0.0b2
-sphinx-jinja2-compat==0.2.0
-sphinx-prompt==1.5.0
-sphinx-reredirects==0.1.2
-Sphinx-Substitution-Extensions==2022.2.16
-sphinx-tabs==3.4.1
-sphinx-toolbox==3.4.0
-sphinxcontrib-applehelp==1.0.4
-sphinxcontrib-devhelp==1.0.2
-sphinxcontrib-htmlhelp==2.0.1
+sphinx-jinja2-compat==0.2.0.post1
+sphinx-prompt==1.8.0
+sphinx-reredirects==0.1.3
+sphinx-substitution-extensions==2024.2.25
+sphinx-tabs==3.4.5
+sphinx-toolbox==3.5.0
+sphinxcontrib-applehelp==1.0.8
+sphinxcontrib-devhelp==1.0.6
+sphinxcontrib-htmlhelp==2.0.5
 sphinxcontrib-jsmath==1.0.1
-sphinxcontrib-qthelp==1.0.3
-sphinxcontrib-serializinghtml==1.1.5
-sphinxcontrib-youtube==1.2.0
+sphinxcontrib-qthelp==1.0.7
+sphinxcontrib-serializinghtml==1.1.10
+sphinxcontrib-youtube==1.4.1
 tabulate==0.9.0
-typing_extensions==4.7.1
-urllib3==2.0.3
+typing_extensions==4.10.0
+urllib3==2.2.1
 webencodings==0.5.1