added logo in main documentation page and prod job (ci/cd)

CERN · Nov 19, 2024 · 5bc9d86 · 5bc9d86
1 parent 7587a46
commit 5bc9d86
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 1 deletion.
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -195,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:

diff --git a/caimira/docs/mkdocs/docs/caimira_logo.png b/caimira/docs/mkdocs/docs/caimira_logo.png
diff --git a/caimira/docs/mkdocs/docs/index.md b/caimira/docs/mkdocs/docs/index.md
@@ -1,9 +1,13 @@
 # Welcome to CAiMIRA’s documentation!
 
-This documentation provides comprehensive guidance on the CERN Airborne Model for Risk Assessment (CAiMIRA) tool. 
+This documentation provides comprehensive guidance on the CERN Airborne Model for Risk Assessment ([CAiMIRA](https://caimira.web.cern.ch/)) tool.
 
 It includes details on the diameter-dependent mathematical model and the code developed based on the underlying published research. It also covers documentation on the code itself, including explanations of the main module (`models.py`), and the recently added REST API feature, providing a through understanding of the CAiMIRA's functionality.
 
+<figure markdown="span">
+  [![CAiMIRA logo](caimira_logo.png){ width="100" }](https://caimira.web.cern.ch/)
+</figure>
+
 # Contents:
 
 * [About](root/about.md)

diff --git a/caimira/docs/mkdocs/mkdocs.yml b/caimira/docs/mkdocs/mkdocs.yml
@@ -28,6 +28,8 @@ markdown_extensions:
       toc_depth: '1-3'
   - admonition
   - pymdownx.details
+  - attr_list
+  - md_in_html
 
 extra_javascript:
   - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js