1 #### Generate the whole html documentation
3 find_path(DOXYGEN_PATH NAMES doxygen PATHS NO_DEFAULT_PATHS)
4 find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS)
8 execute_process(COMMAND ${DOXYGEN_PATH}/doxygen --version OUTPUT_VARIABLE DOXYGEN_VERSION )
9 string(REGEX MATCH "^[0-9]" DOXYGEN_MAJOR_VERSION "${DOXYGEN_VERSION}")
10 string(REGEX MATCH "^[0-9].[0-9]" DOXYGEN_MINOR_VERSION "${DOXYGEN_VERSION}")
11 string(REGEX MATCH "^[0-9].[0-9].[0-9]" DOXYGEN_PATCH_VERSION "${DOXYGEN_VERSION}")
12 string(REGEX REPLACE "^${DOXYGEN_MINOR_VERSION}." "" DOXYGEN_PATCH_VERSION "${DOXYGEN_PATCH_VERSION}")
13 string(REGEX REPLACE "^${DOXYGEN_MAJOR_VERSION}." "" DOXYGEN_MINOR_VERSION "${DOXYGEN_MINOR_VERSION}")
14 message(STATUS "Doxygen version : ${DOXYGEN_MAJOR_VERSION}.${DOXYGEN_MINOR_VERSION}.${DOXYGEN_PATCH_VERSION}")
16 if(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
17 ADD_CUSTOM_TARGET(error_doxygen
18 COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation"
22 add_dependencies(simgrid_documentation error_doxygen)
25 configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
27 ADD_CUSTOM_TARGET(simgrid_documentation
28 COMMENT "Generating the SimGrid documentation..."
29 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
30 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
31 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/html
32 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
36 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_modules.png
37 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
38 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png
39 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png
40 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_01.png
41 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_02.png
42 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_03.png
43 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_04.png
44 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_05.png
45 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_06.png
46 ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css
50 TARGET simgrid_documentation
51 COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
55 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
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/simgrid_modules.map
57 COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen"
58 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
59 COMMAND ${CMAKE_COMMAND} -E echo "XX Generate the index files"
60 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
61 COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc
62 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc
63 COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen again"
64 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
65 COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map
66 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
70 COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
72 COMMAND make pdf || true
73 COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
74 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
75 COMMAND make pdf || true
76 COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
77 COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
78 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
80 add_dependencies(pdf simgrid_documentation)
85 #############################################
86 ### Fill in the "make sync-gforge" target ###
87 #############################################
89 add_custom_target(sync-gforge-doc
90 COMMAND chmod g+rw -R doc/
91 COMMAND chmod a+rX -R doc/
92 COMMAND ssh scm.gforge.inria.fr mkdir -p /home/groups/simgrid/htdocs/simgrid/${release_version}/html/ || true
93 COMMAND ssh scm.gforge.inria.fr mkdir -p /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html/ || true
95 COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
96 doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true
98 COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
99 doc/ref_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html || true
101 COMMAND scp doc/html/simgrid_modules2.png doc/html/simgrid_modules.png doc/webcruft/simgrid_logo_2011.png
102 doc/webcruft/simgrid_logo_2011_small.png scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/
103 WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
105 add_dependencies(sync-gforge-doc simgrid_documentation)
107 add_custom_target(sync-gforge-dtd
108 COMMAND scp src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/simgrid.dtd
109 COMMAND scp src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid.dtd
110 WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"