1 #### Generate the html documentation
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 set(REFDOCSSOURCES "${source_doxygen}\n${REF_GUIDE_SOURCES}")
12 string(REPLACE "\n" ";" REFDOCSSOURCES ${REFDOCSSOURCES})
16 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
17 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png
20 configure_file(${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen/RefGuideDoxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen/RefGuideDoxyfile @ONLY)
22 ADD_CUSTOM_TARGET(ref_guide
23 COMMENT "Generating the SimGrid ref guide..."
24 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
25 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html
26 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html
27 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/
30 ADD_CUSTOM_COMMAND(TARGET ref_guide
31 DEPENDS ${source_doxygen}
32 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen/logcategories.doc
33 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen/logcategories.doc
34 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}
37 foreach(file ${DOC_FIGS})
38 string(REPLACE ".fig" ".png" tmp_file ${file})
39 string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html/" tmp_file ${tmp_file})
40 ADD_CUSTOM_COMMAND(TARGET ref_guide
41 COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file}
43 endforeach(file ${DOC_FIGS})
45 foreach(file ${DOC_PNGS})
46 ADD_CUSTOM_COMMAND(TARGET ref_guide
47 COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html/
49 endforeach(file ${DOC_PNGS})
51 ADD_CUSTOM_COMMAND(TARGET ref_guide
52 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html/
55 ADD_CUSTOM_COMMAND(TARGET ref_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/ref_guide/doxygen/simgrid_modules.map
57 COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
58 COMMAND ${DOXYGEN_PATH}/doxygen RefGuideDoxyfile
59 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgridrefguide.tag index-API.doc
61 COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
62 COMMAND ${DOXYGEN_PATH}/doxygen RefGuideDoxyfile
64 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html/dir*
67 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen
70 else(DOXYGEN_PATH AND FIG2DEV_PATH)
72 ADD_CUSTOM_TARGET(ref_guide
73 COMMENT "Generating the SimGrid documentation..."
76 ADD_CUSTOM_COMMAND(TARGET ref_guide
77 COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH = ${DOXYGEN_PATH}"
78 COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH = ${FIG2DEV_PATH}"
79 COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
80 COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..."
87 ##############################################################################"
90 ADD_CUSTOM_TARGET(ref_guide_pdf
91 COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
93 COMMAND make pdf || true
94 COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
95 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
96 COMMAND make pdf || true
97 COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
98 COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
100 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
102 add_dependencies(ref_guide_pdf ref_guide)