buildtools/Cmake/GenerateDevGuide.cmake

   1 #### Generate the html documentation
   2
   3 if(DOXYGEN_PATH)
   4
   5   set(DOC_PNGS
   6     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
   7     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png
   8     )
   9
  10   configure_file(${CMAKE_HOME_DIRECTORY}/doc/dev_guide/doxygen/DevGuideDoxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/doxygen/DevGuideDoxyfile @ONLY)
  11
  12   ADD_CUSTOM_TARGET(dev_guide
  13     COMMENT "Generating the SimGrid dev guide..."
  14     DEPENDS ${DEV_GUIDE_SOURCES}
  15     COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/html
  16     COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/latex
  17     COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/shared/doxygen/simgriddevguide.tag
  18     COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/html
  19     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/html/
  20     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/doxygen/output.goal.pdf ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/html/
  21     )
  22
  23   foreach(file ${DOC_FIGS})
  24     string(REPLACE ".fig" ".png" tmp_file ${file})
  25     string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_HOME_DIRECTORY}/doc/dev_guide/html/" tmp_file ${tmp_file})
  26     ADD_CUSTOM_COMMAND(TARGET dev_guide
  27       COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file}
  28       )
  29   endforeach(file ${DOC_FIGS})
  30
  31   foreach(file ${DOC_PNGS})
  32     ADD_CUSTOM_COMMAND(TARGET dev_guide
  33       COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/html/
  34       )
  35   endforeach(file ${DOC_PNGS})
  36
  37   ADD_CUSTOM_COMMAND(TARGET dev_guide
  38     COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
  39     COMMAND ${CMAKE_COMMAND} -E chdir ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/doxygen/ doxygen ./DevGuideDoxyfile
  40
  41     COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
  42     COMMAND ${CMAKE_COMMAND} -E chdir ${CMAKE_HOME_DIRECTORY}/doc/dev_guide/doxygen/ doxygen ./DevGuideDoxyfile
  43     )
  44
  45 else()
  46
  47   ADD_CUSTOM_TARGET(dev_guide
  48     COMMENT "Generating the SimGrid documentation..."
  49     )
  50
  51   ADD_CUSTOM_COMMAND(TARGET dev_guide
  52     COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH     = ${DOXYGEN_PATH}"
  53     COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
  54     COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..."
  55     COMMAND false
  56     )
  57
  58 endif()
  59
  60 ##############################################################################"