Merge branch 'gitlab-pages-doxygen' into 'master'

improvements to Doxygen pages

See merge request !330

.gitlab-ci.yml

@@ -35,9 +35,9 @@ doxygen:
     - make BUILDDIR=build doc
     - rm -rf public
     - mkdir -p public/doxygen
-    - mv build/doxygen/html ${CI_COMMIT_REF_NAME}
+    - mv build/doxygen/html ${CI_COMMIT_REF_SLUG}
     - yum install -y zip
-    - zip -r public/doxygen/${CI_COMMIT_REF_NAME}.zip ${CI_COMMIT_REF_NAME}
+    - zip -r public/doxygen/${CI_COMMIT_REF_SLUG}.zip ${CI_COMMIT_REF_SLUG}
   only:
     - master
     - tags

GaudiRelease/doc/doxygen/CMakeLists.txt

@@ -104,6 +104,26 @@ Release notes of the packages:
   string(REGEX REPLACE "\\." "_" Boost_url_version "${Boost_version}")
   string(REGEX REPLACE "\\..*" "" XercesC_major_version "${XercesC_config_version}")
 
+  # define the project version to show in the mainpage
+  message(STATUS "----> $ENV{CI_COMMIT_REF_NAME} ($ENV{CI_COMMIT_SHA})")
+  if(DEFINED ENV{CI_COMMIT_REF_NAME})
+    string(SUBSTRING "$ENV{CI_COMMIT_SHA}" 0 8 CI_COMMIT_SHA)
+    set(DOC_PROJECT_VERSION "$ENV{CI_COMMIT_REF_NAME} (${CI_COMMIT_SHA})")
+  elseif(EXISTS "${CMAKE_SOURCE_DIR}/.git")
+    execute_process(COMMAND git describe --tags
+                    WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
+                    OUTPUT_VARIABLE GIT_DESCRIBE_VERSION
+                    OUTPUT_STRIP_TRAILING_WHITESPACE)
+    execute_process(COMMAND git rev-parse HEAD
+                    WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
+                    OUTPUT_VARIABLE GIT_COMMIT_SHA
+                    OUTPUT_STRIP_TRAILING_WHITESPACE)
+    string(SUBSTRING "${GIT_COMMIT_SHA}" 0 8 GIT_COMMIT_SHA)
+    set(DOC_PROJECT_VERSION "${GIT_DESCRIBE_VERSION} (${GIT_COMMIT_SHA})")
+  else()
+    set(DOC_PROJECT_VERSION "${CMAKE_PROJECT_VERSION}")
+  endif()
+
   # copy the template files
   foreach(template Doxyfile mainpage.md externaldocs.md)
     configure_file(${template}.in ${CMAKE_CURRENT_BINARY_DIR}/${template} @ONLY)

GaudiRelease/doc/doxygen/Doxyfile.in

@@ -38,7 +38,7 @@ PROJECT_NAME           = "The Gaudi Framework"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = @CMAKE_PROJECT_VERSION@
+PROJECT_NUMBER         = "@DOC_PROJECT_VERSION@"
 
 # 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

GaudiRelease/doc/doxygen/mainpage.md.in

@@ -11,14 +11,14 @@ the [list of classes](annotated.html) or via the [class hierarchy](hierarchy.htm
 
 
 <table>
-<tr><th>Version</th><td>@CMAKE_PROJECT_VERSION@</td></tr>
+<tr><th>Version</th><td>@DOC_PROJECT_VERSION@</td></tr>
 <tr><th>Description</th><td>Details of the constituent package versions are
     available in the [detailed release notes](@ref release_notes_main)<br/>
     The [project release notes](release.notes.html) contain a summary of changes
     since the previous release.</td></tr>
 <tr><th>Supported Platforms</th><td>Scientific Linux CERN 6 with gcc-4.8 (released with debug and non debug
     versions, 64 bits only, with C++11 enabled)</td></tr>
-<tr><th>Download</th><td>[Sources][source-tar]</td></tr>
+<tr><th>Download</th><td>[Sources (on gitlab.cern.ch)][sources]</td></tr>
 <tr><th>Documentation</th><td>%Gaudi Developers Guide [v9][gug-html]
     ([.pdf][gug-pdf], [.pdf 2up (for printing)][gug-2up-pdf])</td></tr>
 </table>
@@ -26,7 +26,7 @@ the [list of classes](annotated.html) or via the [class hierarchy](hierarchy.htm
 
 See also: \ref externaldocs (from [LCG version @heptools_version@][lcg-details])
 
-[source-tar]: http://lhcbproject.web.cern.ch/lhcbproject/dist/GAUDI/GAUDI_GAUDI_@CMAKE_PROJECT_VERSION@.tar.gz
+[sources]: https://gitlab.cern.ch/gaudi/Gaudi/tags
 
 [gug-html]: http://cern.ch/lhcb-comp/Frameworks/Gaudi/Gaudi_v9/GUG/Output/GUG.htm
 [gug-pdf]: http://cern.ch/lhcb-comp/Frameworks/Gaudi/Gaudi_v9/GUG/GUG.pdf