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 include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateUserGuide.cmake)
17 include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateRefGuide.cmake)
18 include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateDevGuide.cmake)
21 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
22 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png
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
35 foreach(file ${DOC_PNGS})
37 TARGET simgrid_documentation
38 COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
40 endforeach(file ${DOC_PNGS})
42 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
43 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/
46 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
47 COMMAND ${CMAKE_COMMAND} -E echo "XX Doxygen pass"
48 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
49 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
53 COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
55 COMMAND make pdf || true
56 COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
57 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
58 COMMAND make pdf || true
59 COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
60 COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
61 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
63 add_dependencies(pdf simgrid_documentation)
65 ADD_CUSTOM_TARGET(error_doxygen
66 COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation"
70 if(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
71 add_dependencies(simgrid_documentation error_doxygen)
72 else(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
73 add_dependencies(simgrid_documentation ref_guide)
74 add_dependencies(simgrid_documentation user_guide)
75 add_dependencies(simgrid_documentation dev_guide)
76 endif(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
80 #############################################
81 ### Fill in the "make sync-gforge" target ###
82 #############################################
84 ### TODO: LBO: CHECK IF CORRECT
85 add_custom_target(sync-gforge-doc
86 COMMAND chmod g+rw -R doc/
87 COMMAND chmod a+rX -R doc/
88 COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ || true
89 COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/ || true
90 COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/ || true
91 COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true
92 COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html/ || true
93 COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
94 doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true
95 COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
96 doc/user_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true
97 COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
98 doc/ref_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html || true
99 COMMAND scp doc/user_guide/html/simgrid_modules2.png doc/user_guide/html/simgrid_modules.png doc/webcruft/simgrid_logo_2011.png
100 doc/webcruft/simgrid_logo_2011_small.png scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/
101 WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
103 add_dependencies(sync-gforge-doc simgrid_documentation)
105 add_custom_target(sync-gforge-dtd
106 COMMAND scp src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/simgrid.dtd
107 COMMAND scp src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid.dtd
108 WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"