1 #### Generate the html documentation for the user guide.
3 file(GLOB_RECURSE source_doxygen
4 "${CMAKE_HOME_DIRECTORY}/tools/gras/*.[chl]"
5 "${CMAKE_HOME_DIRECTORY}/src/*.[chl]"
6 "${CMAKE_HOME_DIRECTORY}/include/*.[chl]"
11 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
12 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png
13 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png
14 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_01.png
15 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_02.png
16 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_03.png
17 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_04.png
18 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_05.png
19 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_06.png
22 configure_file(${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/UserGuideDoxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/UserGuideDoxyfile @ONLY)
24 ADD_CUSTOM_TARGET(user_guide
25 COMMENT "Generating the SimGrid user guide..."
26 DEPENDS ${USER_GUIDE_SOURCES} ${DOC_FIGS} ${source_doxygen}
27 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html
28 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html
29 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen
32 foreach(file ${DOC_FIGS})
33 string(REPLACE ".fig" ".png" tmp_file ${file})
34 string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/" tmp_file ${tmp_file})
35 ADD_CUSTOM_COMMAND(TARGET user_guide
36 COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file}
38 endforeach(file ${DOC_FIGS})
40 foreach(file ${DOC_PNGS})
41 ADD_CUSTOM_COMMAND(TARGET user_guide
42 COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/
44 endforeach(file ${DOC_PNGS})
46 ADD_CUSTOM_COMMAND(TARGET user_guide
47 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/
48 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/
49 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/
50 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/
51 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-time_interval.png ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/
52 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/AS_hierarchy.png ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/
53 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/
56 ADD_CUSTOM_COMMAND(TARGET user_guide
57 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
58 COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
59 COMMAND ${DOXYGEN_PATH}/doxygen UserGuideDoxyfile
61 COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
62 COMMAND ${DOXYGEN_PATH}/doxygen UserGuideDoxyfile
64 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/dir*
66 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen
71 ADD_CUSTOM_TARGET(user_guide
72 COMMENT "Generating the SimGrid user guide..."
75 ADD_CUSTOM_COMMAND(TARGET user_guide
76 COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH = ${DOXYGEN_PATH}"
77 COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH = ${FIG2DEV_PATH}"
78 COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
79 COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..."
85 ADD_CUSTOM_TARGET(user_guide_pdf
86 COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_user_guide.pdf"
88 COMMAND make pdf || true
89 COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_user_guide.pdf"
90 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/user_guide/latex/refman.pdf
91 COMMAND make pdf || true
92 COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
93 COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/user_guide/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
95 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/user_guide/latex/
97 add_dependencies(user_guide_pdf user_guide)