Project documentation and CI/CD improvements:

- Added docs folder with MkDocs and Sphinx integration for documentation.
- Updated GitLab CI/CD configuration to include documentation jobs.
- Improved Dockerfile for streamlined builds.
- Added JavaScript file to support MathJax for equations in MkDocs.
- Created and included a UML diagram for architectural overview.
- Removed unused files to clean up the repository.
- Updated project and package README files for consistency.
- Revised diameter-dependent documentation for clarity.
- Added detailed REST API documentation.
- Updated project version for release tracking.
- Included open-source acknowledgments in the documentation.
- Added repository details and UI instructions to the user guide.
- Integrated CO2 fitting algorithm into the project.
- Included logo on the main documentation page and added CI/CD prod job.

.gitlab-ci.yml

@@ -67,6 +67,7 @@ test-cern-caimira-py39:
 
 .test_openshift_config:
   stage: test
+  allow_failure: true
   image: registry.cern.ch/docker.io/mambaorg/micromamba
   before_script:
     - micromamba create --yes -p $HOME/env python=3.9 ruamel.yaml wget -c conda-forge
@@ -139,6 +140,13 @@ check_openshift_config_prod:
     DOCKER_CONTEXT_DIRECTORY: ""
   extends: .docker-build
 
+.docker-build-docs:
+  variables:
+    IMAGE_NAME: caimira-docs
+    DOCKERFILE_DIRECTORY: "caimira/docs"
+    DOCKER_CONTEXT_DIRECTORY: "caimira"
+  extends: .docker-build
+
 # on push to live/caimira-test
 .docker-build-test:
   variables:
@@ -158,6 +166,14 @@ docker-build-calculator-app-test:
   rules:
     - if: $CI_COMMIT_BRANCH == "live/caimira-test"
 
+docker-build-docs-test:
+  extends: 
+    - .docker-build-docs
+  variables:
+    IMAGE_TAG: caimira-test-docs-latest
+  rules:
+    - if: $CI_COMMIT_BRANCH == "live/caimira-test"
+
 # on release
 .docker-build-release:
   before_script:
@@ -179,6 +195,15 @@ docker-build-calculator-app-release:
   rules:
     - if: $CI_COMMIT_TAG
 
+docker-build-docs-release:
+  extends:
+    - .docker-build-release
+    - .docker-build-docs
+  variables:
+    IMAGE_TAG: caimira-docs-latest
+  rules:
+    - if: $CI_COMMIT_TAG
+
 # ###################################################################################################
 # Deploy to OpenShift
 .deploy:
@@ -217,3 +242,10 @@ deploy-calculator-open-app-test:
     IMAGE_NAME: calculator-app
     OPENSHIFT_DEPLOYMENT: calculator-open-app
     OPENSHIFT_CONTAINER_NAME: calculator-open-app
+
+deploy-docs-test:
+  extends: .deploy
+  variables:
+    IMAGE_NAME: caimira-docs
+    OPENSHIFT_DEPLOYMENT: caimira-test-docs
+    OPENSHIFT_CONTAINER_NAME: caimira-test-docs

CHANGELOG.md

@@ -1,3 +1,12 @@
+# 4.17.5 (November 20, 2024)
+
+## Features Added
+- Mkdocs documentation
+- Folder layout adapted
+
+## Bug Fixes
+- N/A
+
 # 4.17.4 (November 05, 2024)
 
 ## Features Added