sort the elements of this file so that it becomes readable w/o loosing too much menta...

[simgrid.git] / buildtools / Cmake / GenerateDoc.cmake

diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake
index d24b987..1c0f75f 100644 (file)
--- a/buildtools/Cmake/GenerateDoc.cmake
+++ b/buildtools/Cmake/GenerateDoc.cmake
@@ -13,14 +13,15 @@ if(DOXYGEN_PATH)
   string(REGEX REPLACE "^${DOXYGEN_MAJOR_VERSION}." "" DOXYGEN_MINOR_VERSION "${DOXYGEN_MINOR_VERSION}")
   message(STATUS "Doxygen version : ${DOXYGEN_MAJOR_VERSION}.${DOXYGEN_MINOR_VERSION}.${DOXYGEN_PATCH_VERSION}")
 
-  include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateUserGuide.cmake)
-  include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateRefGuide.cmake)
-
-  set(DOC_PNGS
-    ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
-    ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png
+  if(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
+    ADD_CUSTOM_TARGET(error_doxygen
+      COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation"
+      COMMAND false
     )
 
+    add_dependencies(simgrid_documentation error_doxygen)
+  endif()
+
   configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
 
   ADD_CUSTOM_TARGET(simgrid_documentation
@@ -30,21 +31,36 @@ if(DOXYGEN_PATH)
     COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_HOME_DIRECTORY}/doc/html
     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
     )
+    
+  foreach(file 
+    ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_modules.png
+    ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
+    ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png
+    ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png
+    ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_01.png
+    ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_02.png
+    ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_03.png
+    ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_04.png
+    ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_05.png
+    ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_06.png
+    ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css 
+    )
 
-  foreach(file ${DOC_PNGS})
     ADD_CUSTOM_COMMAND(
       TARGET simgrid_documentation
       COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
-      )
-  endforeach(file ${DOC_PNGS})
-
-  ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
-    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/
     )
+  endforeach()
 
   ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
-    COMMAND ${CMAKE_COMMAND} -E echo "XX Doxygen pass"
+    COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/shared/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/<IMG/<IMG style=border:0px/g' | ${CMAKE_HOME_DIRECTORY}/tools/doxygen/fig2dev_postprocessor.pl > ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map
+    COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen"
     COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
+    COMMAND ${CMAKE_COMMAND} -E echo "XX Generate the index file"
+    COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc     
+    COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen again"
+    COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
+    COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map
     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
     )
 
@@ -61,39 +77,25 @@ if(DOXYGEN_PATH)
     )
   add_dependencies(pdf simgrid_documentation)
 
-  ADD_CUSTOM_TARGET(error_doxygen
-    COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation"
-    COMMAND false
-    )
-
-  if(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
-    add_dependencies(simgrid_documentation error_doxygen)
-  else(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
-    add_dependencies(simgrid_documentation ref_guide)
-    add_dependencies(simgrid_documentation user_guide)
-  endif(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
 
-endif(DOXYGEN_PATH)
+endif()
 
 #############################################
 ### Fill in the "make sync-gforge" target ###
 #############################################
 
-### TODO: LBO: CHECK IF CORRECT
 add_custom_target(sync-gforge-doc
   COMMAND chmod g+rw -R doc/
   COMMAND chmod a+rX -R doc/
-  COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ || true
-  COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/ || true
-  COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/ || true
-  COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true
-  COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html/ || true
+  COMMAND ssh scm.gforge.inria.fr mkdir -p /home/groups/simgrid/htdocs/simgrid/${release_version}/html/ || true
+  COMMAND ssh scm.gforge.inria.fr mkdir -p /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html/ || true
+
   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
   doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true
-  COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
-  doc/user_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true
+
   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
   doc/ref_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html || true
+
   COMMAND scp doc/user_guide/html/simgrid_modules2.png doc/user_guide/html/simgrid_modules.png doc/webcruft/simgrid_logo_2011.png
   doc/webcruft/simgrid_logo_2011_small.png scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/
   WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
@@ -105,3 +107,4 @@ add_custom_target(sync-gforge-dtd
   COMMAND scp src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid.dtd
   WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
   )
+