Merge branch 'JK/ci' into 'develop'

CI: deploy with artifacts

See merge request !39

.gitlab-ci.yml

@@ -393,20 +393,34 @@ mpi_benchmarks_tools_python_Release:
         WITH_PYTHON: "yes"
 
 
+
+
+build documentation:
+    stage: build
+    only:
+        changes:
+            - Documentation/**/*
+            - src/TNL/**/*.{h,hpp}
+    script:
+        - ./Documentation/build
+    artifacts:
+        paths:
+            - ./Documentation/html/
+    tags:
+        - doxygen
+
 deploy documentation:
     stage: deploy
     only:
         variables:
             - $TNL_DOC_DEPLOY_KEY
-        changes:
-            - Documentation/**/*
-            - src/TNL/**/*.{h,hpp}
         refs:
             - develop
             - schedules
             - triggers
+    dependencies:
+        - build documentation
     script:
-        - ./Documentation/build
         - ./Documentation/deploy
     tags:
         - doxygen

Documentation/Doxyfile

@@ -37,8 +37,10 @@ PROJECT_NAME           = "Template Numerical Library"
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
+# We pass the value from the build script using an environment variable, see
+# https://stackoverflow.com/a/54487043
 
-PROJECT_NUMBER         = 0.1
+PROJECT_NUMBER         = $(PROJECT_NUMBER)
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

Documentation/build

@@ -30,8 +30,12 @@ done
 # Remove existing html/ directory which may contain old files
 rm -rf ./html/
 
+# Assemble environment variables which are used in the Doxyfile
+#PROJECT_NUMBER="version $(git branch --show-current):$(git log -1 --format="%h (%cd)")"
+PROJECT_NUMBER="version $(git branch --show-current):$(git rev-parse --short HEAD)"
+
 # Generate documentation
-doxygen
+PROJECT_NUMBER="$PROJECT_NUMBER" doxygen
 
 # Install
 if [[ "$INSTALL" == "yes" ]]; then