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}"
111 ##############################################################################"
114 #message(STATUS "Check individual TOCs")
116 #foreach(file_name ${LISTE_GTUT})
117 # file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc)
118 # file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc)
120 # file(READ "${file_name}" file_content)
121 # string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
122 # string(REPLACE "\n" ";" valeur_line "${valeur_line}")
123 # string(REPLACE "\n" ";" file_content "${file_content}")
125 # file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc "\n") # make sure it exists
126 # foreach(line ${file_content})
127 # string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
128 # string(REGEX MATCH ".*_toc.*" line3 "${line}")
129 # if(line2 AND NOT line3)
130 # string(REPLACE "\\section " "" line2 ${line2})
131 # string(REPLACE "\\subsection " "subsection" line2 ${line2})
132 # string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2})
133 # string(REGEX REPLACE " .*" "" line2 ${line2})
134 # set(line2 " - \\ref ${line2}")
135 # string(REPLACE " - \\ref subsection" " - \\ref " line2 ${line2})
136 # string(REPLACE " - \\ref subsubsection" " - \\ref " line2 ${line2})
137 # file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc "${line2}\n")
138 # endif(line2 AND NOT line3)
139 # endforeach(line ${file_content})
141 # file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc "\n") # make sure it exists
142 # foreach(line ${valeur_line})
143 # string(REGEX MATCH ".*ref.*" line_ok ${line})
145 # file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc "${line_ok}\n")
147 # endforeach(line ${valeur_line})
149 # exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc" OUTPUT_VARIABLE compare_files)
151 # message(STATUS "Wrong toc for ${file_name}. Should be:")
152 # file(READ "${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc" file_content)
153 # message("${file_content}")
154 # exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc")
155 # endif(compare_files)
156 #endforeach(file_name ${LISTE_GTUT})
158 #file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc)
159 #file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc)
161 #message(STATUS "Check main TOC")
163 #foreach(file_name ${LISTE_GTUT})
164 # file(READ "${file_name}" file_content)
165 # string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
166 # string(REPLACE "\n" ";" valeur_line "${valeur_line}")
167 # string(REPLACE "\n" ";" file_content "${file_content}")
169 # foreach(line ${file_content})
170 # string(REGEX MATCH ".*@page.*" line2 "${line}")
172 # string(REPLACE "@page " "" line2 "${line2}")
173 # string(REGEX REPLACE " .*" "" line2 "${line2}")
174 # set(line2 " - \\ref ${line2}")
175 # file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc "${line2}\n")
177 # endforeach(line ${file_content})
179 # foreach(line ${valeur_line})
180 # string(REGEX MATCH ".*toc.*" line1 "${line}")
181 # string(REGEX MATCH ".*<hr>.*" line2 "${line}")
182 # string(REGEX MATCH "^[ ]*$" line3 "${line}")
183 # string(REGEX MATCH "Table of Contents" line4 "${line}")
184 # if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
185 # file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc " ${line}\n")
186 # endif(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
187 # endforeach(line ${valeur_line})
188 #endforeach(file_name ${LISTE_GTUT})
190 #file(READ "${CMAKE_HOME_DIRECTORY}/doc/doxygen/gtut-tour.doc" file_content)
191 #string(REPLACE "\n" ";" file_content "${file_content}")
192 #foreach(line ${file_content})
193 # string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}")
195 # file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc "${line}\n")
197 #endforeach(line ${file_content})
199 #exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc" OUTPUT_VARIABLE compare_files)
201 # message(STATUS "Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
202 # exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc")
204 # file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc)
205 #endif(compare_files)
207 #file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc)