buildtools/Cmake/GenerateDoc.cmake

   1 #### Generate the whole html documentation
   2
   3 find_path(DOXYGEN_PATH  NAMES doxygen  PATHS NO_DEFAULT_PATHS)
   4 find_path(FIG2DEV_PATH  NAMES fig2dev  PATHS NO_DEFAULT_PATHS)
   5
   6 if(DOXYGEN_PATH)
   7
   8   execute_process(COMMAND ${DOXYGEN_PATH}/doxygen --version OUTPUT_VARIABLE DOXYGEN_VERSION )
   9   string(REGEX MATCH "^[0-9]" DOXYGEN_MAJOR_VERSION "${DOXYGEN_VERSION}")
  10   string(REGEX MATCH "^[0-9].[0-9]" DOXYGEN_MINOR_VERSION "${DOXYGEN_VERSION}")
  11   string(REGEX MATCH "^[0-9].[0-9].[0-9]" DOXYGEN_PATCH_VERSION "${DOXYGEN_VERSION}")
  12   string(REGEX REPLACE "^${DOXYGEN_MINOR_VERSION}." "" DOXYGEN_PATCH_VERSION "${DOXYGEN_PATCH_VERSION}")
  13   string(REGEX REPLACE "^${DOXYGEN_MAJOR_VERSION}." "" DOXYGEN_MINOR_VERSION "${DOXYGEN_MINOR_VERSION}")
  14   message(STATUS "Doxygen version : ${DOXYGEN_MAJOR_VERSION}.${DOXYGEN_MINOR_VERSION}.${DOXYGEN_PATCH_VERSION}")
  15
  16   include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateUserGuide.cmake)
  17   include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateRefGuide.cmake)
  18   include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateDevGuide.cmake)
  19
  20   set(DOC_PNGS
  21     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_modules.png
  22     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
  23     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png
  24     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png
  25     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_01.png
  26     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_02.png
  27     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_03.png
  28     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_04.png
  29     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_05.png
  30     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_06.png
  31     )
  32
  33   configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
  34
  35   ADD_CUSTOM_TARGET(simgrid_documentation
  36     COMMENT "Generating the SimGrid documentation..."
  37     DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
  38     COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
  39     COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_HOME_DIRECTORY}/doc/html
  40     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  41     )
  42
  43   foreach(file ${DOC_PNGS})
  44     ADD_CUSTOM_COMMAND(
  45       TARGET simgrid_documentation
  46       COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
  47       )
  48   endforeach(file ${DOC_PNGS})
  49
  50   ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  51     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/
  52     )
  53
  54   ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  55     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
  56     COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen"
  57     COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
  58     COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map
  59     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  60     )
  61
  62   ADD_CUSTOM_TARGET(pdf
  63     COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
  64     COMMAND make clean
  65     COMMAND make pdf || true
  66     COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
  67     COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
  68     COMMAND make pdf || true
  69     COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
  70     COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
  71     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
  72     )
  73   add_dependencies(pdf simgrid_documentation)
  74
  75   ADD_CUSTOM_TARGET(error_doxygen
  76     COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation"
  77     COMMAND false
  78     )
  79
  80   if(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
  81     add_dependencies(simgrid_documentation error_doxygen)
  82   else()
  83     add_dependencies(simgrid_documentation ref_guide)
  84     add_dependencies(simgrid_documentation dev_guide)
  85   endif()
  86
  87 endif()
  88
  89 #############################################
  90 ### Fill in the "make sync-gforge" target ###
  91 #############################################
  92
  93 ### TODO: LBO: CHECK IF CORRECT
  94 add_custom_target(sync-gforge-doc
  95   COMMAND chmod g+rw -R doc/
  96   COMMAND chmod a+rX -R doc/
  97   COMMAND ssh scm.gforge.inria.fr mkdir -p /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true
  98   COMMAND ssh scm.gforge.inria.fr mkdir -p /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html/ || true
  99   COMMAND ssh scm.gforge.inria.fr mkdir -p /home/groups/simgrid/htdocs/simgrid/${release_version}/dev_guide/html/ || true
 100
 101   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
 102   doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true
 103
 104   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
 105   doc/user_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true
 106
 107   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
 108   doc/ref_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html || true
 109
 110   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
 111   doc/dev_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/dev_guide/html || true
 112
 113   COMMAND scp doc/user_guide/html/simgrid_modules2.png doc/user_guide/html/simgrid_modules.png doc/webcruft/simgrid_logo_2011.png
 114   doc/webcruft/simgrid_logo_2011_small.png scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/
 115   WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
 116   )
 117 add_dependencies(sync-gforge-doc simgrid_documentation)
 118
 119 add_custom_target(sync-gforge-dtd
 120   COMMAND scp src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/simgrid.dtd
 121   COMMAND scp src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid.dtd
 122   WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
 123   )
 124