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
  19   set(DOC_PNGS
  20     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
  21     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png
  22     )
  23
  24   configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
  25
  26   ADD_CUSTOM_TARGET(simgrid_documentation
  27     COMMENT "Generating the SimGrid documentation..."
  28     DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
  29     COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
  30     COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_HOME_DIRECTORY}/doc/html
  31     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  32     )
  33
  34   foreach(file ${DOC_PNGS})
  35     ADD_CUSTOM_COMMAND(
  36       TARGET simgrid_documentation
  37       COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
  38       )
  39   endforeach(file ${DOC_PNGS})
  40
  41   ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  42     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/
  43     )
  44
  45   ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  46     COMMAND ${CMAKE_COMMAND} -E echo "XX Doxygen pass"
  47     COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
  48     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  49     )
  50
  51   ADD_CUSTOM_TARGET(pdf
  52     COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
  53     COMMAND make clean
  54     COMMAND make pdf || true
  55     COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
  56     COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
  57     COMMAND make pdf || true
  58     COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
  59     COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
  60     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
  61     )
  62   add_dependencies(pdf simgrid_documentation)
  63
  64   ADD_CUSTOM_TARGET(error_doxygen
  65     COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation"
  66     COMMAND false
  67     )
  68
  69   if(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
  70     add_dependencies(simgrid_documentation error_doxygen)
  71   else(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
  72     add_dependencies(simgrid_documentation ref_guide)
  73     add_dependencies(simgrid_documentation user_guide)
  74   endif(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
  75
  76 endif(DOXYGEN_PATH)
  77
  78 #############################################
  79 ### Fill in the "make sync-gforge" target ###
  80 #############################################
  81
  82 ### TODO: LBO: CHECK IF CORRECT
  83 add_custom_target(sync-gforge-doc
  84   COMMAND chmod g+rw -R doc/
  85   COMMAND chmod a+rX -R doc/
  86   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ || true
  87   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/ || true
  88   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/ || true
  89   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true
  90   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html/ || true
  91   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
  92   doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true
  93   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
  94   doc/user_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true
  95   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
  96   doc/ref_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html || true
  97   COMMAND scp doc/user_guide/html/simgrid_modules2.png doc/user_guide/html/simgrid_modules.png doc/webcruft/simgrid_logo_2011.png
  98   doc/webcruft/simgrid_logo_2011_small.png scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/
  99   WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
 100   )
 101 add_dependencies(sync-gforge-doc simgrid_documentation)
 102
 103 add_custom_target(sync-gforge-dtd
 104   COMMAND scp src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/simgrid.dtd
 105   COMMAND scp src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid.dtd
 106   WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
 107   )