1 #### Generate the whole html documentation
3 find_path(DOXYGEN_PATH NAMES doxygen PATHS NO_DEFAULT_PATHS)
4 find_path(JAVADOC_PATH NAMES javadoc PATHS NO_DEFAULT_PATHS)
5 find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS)
6 mark_as_advanced(JAVADOC_PATH)
10 ADD_CUSTOM_TARGET(simgrid_documentation
11 COMMENT "Generating the SimGrid documentation..."
12 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
13 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
14 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/html
15 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
18 execute_process(COMMAND ${DOXYGEN_PATH}/doxygen --version OUTPUT_VARIABLE DOXYGEN_VERSION )
19 message(STATUS "Doxygen version: ${DOXYGEN_VERSION}")
21 if(DOXYGEN_VERSION VERSION_LESS "1.8")
22 ADD_CUSTOM_TARGET(error_doxygen
23 COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation"
27 add_dependencies(simgrid_documentation error_doxygen)
30 configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
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/html/" tmp_file ${tmp_file})
35 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
36 COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file}
40 foreach(file ${DOC_IMG})
42 TARGET simgrid_documentation
43 COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
47 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
48 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/simgrid_modules.map
50 COMMAND ${CMAKE_COMMAND} -E tar czf html/msg-tuto-src.tgz msg-tuto-src/
51 COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen"
52 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
53 COMMAND ${CMAKE_COMMAND} -E echo "XX Generate the index files"
54 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
55 COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc
56 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc
57 COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen again"
58 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
59 COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map
60 COMMAND ${CMAKE_COMMAND} -E echo "XX Javadoc pass"
61 COMMAND ${JAVADOC_PATH}/javadoc -quiet -d ${CMAKE_HOME_DIRECTORY}/doc/html/javadoc/ ${CMAKE_HOME_DIRECTORY}/src/bindings/java/org/simgrid/*.java ${CMAKE_HOME_DIRECTORY}/src/bindings/java/org/simgrid/*/*.java
62 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
66 COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
68 COMMAND make pdf || true
69 COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
70 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
71 COMMAND make pdf || true
72 COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
73 COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
74 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
76 add_dependencies(pdf simgrid_documentation)
81 #############################################
82 ### Fill in the "make sync-gforge" target ###
83 #############################################
85 set(RSYNC_CMD rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --times --omit-dir-times --perms --chmod=a+rX,ug+w,o-w,Dg+s)
87 add_custom_target(sync-gforge-doc
88 COMMAND ssh scm.gforge.inria.fr mkdir -p -m 2775 /home/groups/simgrid/htdocs/simgrid/${release_version}/ || true
90 COMMAND ${RSYNC_CMD} doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true
92 COMMAND ${RSYNC_CMD} doc/html/simgrid_modules2.png doc/html/simgrid_modules.png doc/webcruft/simgrid_logo_2011.png
93 doc/webcruft/simgrid_logo_2011_small.png scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/
95 WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
97 add_dependencies(sync-gforge-doc simgrid_documentation)
99 add_custom_target(sync-gforge-dtd
100 COMMAND ${RSYNC_CMD} src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/simgrid.dtd
101 COMMAND ${RSYNC_CMD} src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid.dtd
102 WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"