Develop

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.

.gitlab/ci/.mk-docs-deploy.yml

-image: ${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/python:latest
-pages:
-  stage: deploy
+image: ${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/python:3.9.15
+cache:
+  # keep artifacts from previous builds
+  paths:
+    - public
+documentation:
+  stage: publish
   script:
     - pip install mkdocs-material
-    - mkdocs build --site-dir public
+    - mkdocs build --site-dir public/$CI_COMMIT_BRANCH
+  needs: []
   artifacts:
+    name: "$CI_COMMIT_BRANCH"
     paths:
       - public
+    expire_in: 1 week
   rules:
-    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+      # run only for protected branches; in our case this should be master and
+      # develop.
+    - if: $CI_COMMIT_REF_PROTECTED == "true"