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