buildtools/Cmake/GenerateUserGuide.cmake

   1 #### Generate the html documentation for the user guide.
   2
   3 file(GLOB_RECURSE source_doxygen
   4   "${CMAKE_HOME_DIRECTORY}/src/*.[chl]"
   5   "${CMAKE_HOME_DIRECTORY}/include/*.[chl]"
   6   )
   7
   8 if(FIG2DEV_PATH)
   9
  10   configure_file(${CMAKE_HOME_DIRECTORY}/doc/doxygen/UserGuideDoxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/doxygen/UserGuideDoxyfile @ONLY)
  11
  12   ADD_CUSTOM_TARGET(user_guide
  13     COMMENT "Generating the SimGrid user guide..."
  14     DEPENDS ${USER_GUIDE_SOURCES} ${DOC_FIGS} ${source_doxygen}
  15     COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
  16     COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_HOME_DIRECTORY}/doc/html
  17     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/doxygen
  18     )
  19
  20   foreach(file ${DOC_FIGS})
  21     string(REPLACE ".fig" ".png" tmp_file ${file})
  22     string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
  23     ADD_CUSTOM_COMMAND(TARGET user_guide
  24       COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file}
  25       )
  26   endforeach(file ${DOC_FIGS})
  27
  28   foreach(file ${DOC_PNGS})
  29     ADD_CUSTOM_COMMAND(TARGET user_guide
  30       COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
  31       )
  32   endforeach(file ${DOC_PNGS})
  33
  34   ADD_CUSTOM_COMMAND(TARGET user_guide
  35     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/
  36     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg     ${CMAKE_HOME_DIRECTORY}/doc/html/
  37     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png        ${CMAKE_HOME_DIRECTORY}/doc/html/
  38     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png        ${CMAKE_HOME_DIRECTORY}/doc/html/
  39     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-time_interval.png        ${CMAKE_HOME_DIRECTORY}/doc/html/
  40     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/AS_hierarchy.png        ${CMAKE_HOME_DIRECTORY}/doc/html/
  41     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css                          ${CMAKE_HOME_DIRECTORY}/doc/html/
  42     )
  43
  44   ADD_CUSTOM_COMMAND(TARGET user_guide
  45     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/doxygen/simgrid_modules.map
  46     COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
  47     COMMAND ${DOXYGEN_PATH}/doxygen UserGuideDoxyfile
  48
  49     COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
  50     COMMAND ${DOXYGEN_PATH}/doxygen UserGuideDoxyfile
  51
  52     COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir*
  53
  54     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/doxygen
  55     )
  56
  57 else()
  58
  59   ADD_CUSTOM_TARGET(user_guide
  60     COMMENT "Generating the SimGrid user guide..."
  61     )
  62
  63   ADD_CUSTOM_COMMAND(TARGET user_guide
  64     COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH              = ${DOXYGEN_PATH}"
  65     COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH              = ${FIG2DEV_PATH}"
  66     COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
  67     COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..."
  68     COMMAND false
  69     )
  70
  71 endif()
  72
  73 ADD_CUSTOM_TARGET(user_guide_pdf
  74     COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_user_guide.pdf"
  75     COMMAND make clean
  76     COMMAND make pdf || true
  77     COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_user_guide.pdf"
  78     COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
  79     COMMAND make pdf || true
  80     COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
  81     COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
  82
  83     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
  84 )
  85 add_dependencies(user_guide_pdf user_guide)