1 #### Generate the html documentation
4 set(BIBTEX2HTML_PATH ${BIBTEX2HTML})
6 find_path(BIBTEX2HTML_PATH NAMES bibtex2html PATHS NO_DEFAULT_PATHS)
9 find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS)
10 find_path(DOXYGEN_PATH NAMES doxygen PATHS NO_DEFAULT_PATHS)
12 ### Check whether the bibtex2html that we found is the one that Arnaud requires
13 exec_program("${BIBTEX2HTML_PATH}/bibtex2html -version" OUTPUT_VARIABLE OUTPUT_BIBTEX2HTML_VERSION)
14 STRING(REPLACE "[-bibtex]" "" OUTPUT_BIBTEX2HTML_VERSION_2 ${OUTPUT_BIBTEX2HTML_VERSION})
16 file(GLOB_RECURSE source_doxygen
17 "${CMAKE_HOME_DIRECTORY}/tools/gras/*.[chl]"
18 "${CMAKE_HOME_DIRECTORY}/src/*.[chl]"
19 "${CMAKE_HOME_DIRECTORY}/include/*.[chl]"
22 if(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # wrong version
23 SET(GOOD_BIBTEX2HTML_VERSION 0)
24 else(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # good version
25 SET(GOOD_BIBTEX2HTML_VERSION 1)
26 endif(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION})
28 if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION)
30 string(REGEX REPLACE ";.*logcategories.doc" "" LISTE_DEUX "${LISTE_DEUX}")
32 #DOC_SOURCE=doc/*.doc, defined in DefinePackage
33 set(DOCSSOURCES "${source_doxygen}\n${DOC_SOURCE}")
34 string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES})
38 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo.png
39 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
40 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_small.png
41 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png
42 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_01.png
43 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_02.png
44 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_03.png
45 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_04.png
46 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_05.png
47 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_06.png
50 configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
51 configure_file(${CMAKE_HOME_DIRECTORY}/doc/footer.html.in ${CMAKE_HOME_DIRECTORY}/doc/footer.html @ONLY)
53 ADD_CUSTOM_TARGET(simgrid_documentation
54 COMMENT "Generating the SimGrid documentation..."
55 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
56 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
57 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/html
58 COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/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
59 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
63 OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
64 DEPENDS ${source_doxygen}
65 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
66 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
67 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}
70 foreach(file ${DOC_FIGS})
71 string(REPLACE ".fig" ".png" tmp_file ${file})
72 string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
73 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
74 COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng ${file} ${tmp_file}
76 endforeach(file ${DOC_FIGS})
78 foreach(file ${DOC_PNGS})
79 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
80 COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
82 endforeach(file ${DOC_PNGS})
84 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
85 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/
86 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/
87 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png ${CMAKE_HOME_DIRECTORY}/doc/html/
88 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png ${CMAKE_HOME_DIRECTORY}/doc/html/
89 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/AS_hierarchy.png ${CMAKE_HOME_DIRECTORY}/doc/html/
90 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/
93 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
94 COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
95 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
96 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
97 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl pls.doc index.doc FAQ.doc gtut-introduction.doc install.doc bindings.doc options.doc tracing.doc platform.doc
99 COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
100 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
102 COMMAND ${CMAKE_COMMAND} -E echo "XX Post-processing Doxygen result"
103 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir*
104 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl
106 COMMAND ${CMAKE_COMMAND} -E echo "XX Create shortcuts pages"
107 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__GRAS__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html
108 COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__GRAS__API.html'>Grid Reality And Simulation.</a></h2></center></html>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html
110 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__AMOK__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/amok.html
111 COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__AMOK__API.html'>Advanced Metacomputing Overlay Kit.</a></h2></center></html>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/amok.html
113 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__MSG__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/msg.html
114 COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__MSG__API.html'>Meta SimGrid.</a></h2></center></html>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/msg.html
116 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__SD__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/simdag.html
117 COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__SD__API.html'>DAG Simulator.</a></h2></center></html>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/simdag.html
118 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/
121 else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION)
123 ADD_CUSTOM_TARGET(simgrid_documentation
124 COMMENT "Generating the SimGrid documentation..."
127 if(NOT GOOD_BIBTEX2HTML_VERSION) # wrong version
128 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
129 COMMAND ${CMAKE_COMMAND} -E echo "This is not the good bibtex2html program !!!"
130 COMMAND ${CMAKE_COMMAND} -E echo "You can download it from:"
131 COMMAND ${CMAKE_COMMAND} -E echo " ftp://ftp-sop.inria.fr/epidaure/Softs/bibtex2html/bibtex2html-1.02.tar.gz"
132 COMMAND ${CMAKE_COMMAND} -E echo "There is also an unofficial Debian/Ubuntu package, see:"
133 COMMAND ${CMAKE_COMMAND} -E echo " http://www.loria.fr/~lnussbau/bibtex2html/README"
135 endif(NOT GOOD_BIBTEX2HTML_VERSION)
137 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
138 COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH = ${DOXYGEN_PATH}"
139 COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH = ${FIG2DEV_PATH}"
140 COMMAND ${CMAKE_COMMAND} -E echo "BIBTEX2HTML_PATH = ${BIBTEX2HTML_PATH}"
141 COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
142 COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..."
147 endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION)
149 ##############################################################################"
151 message(STATUS "Check individual TOCs")
153 doc/gtut-tour-00-install.doc
154 doc/gtut-tour-01-bones.doc
155 doc/gtut-tour-02-simple.doc
156 doc/gtut-tour-03-args.doc
157 doc/gtut-tour-04-callback.doc
158 doc/gtut-tour-05-globals.doc
159 doc/gtut-tour-06-logs.doc
160 doc/gtut-tour-07-timers.doc
161 doc/gtut-tour-08-exceptions.doc
162 doc/gtut-tour-09-simpledata.doc
163 doc/gtut-tour-10-rpc.doc
164 doc/gtut-tour-11-explicitwait.doc
165 doc/gtut-tour-recap-messages.doc
166 doc/gtut-tour-12-staticstruct.doc
167 doc/gtut-tour-13-pointers.doc
168 doc/gtut-tour-14-dynar.doc
169 doc/gtut-tour-15-manualdatadef.doc
170 doc/gtut-tour-16-exchangecb.doc
173 foreach(file_name ${LISTE_GTUT})
174 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
175 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
177 file(READ "${file_name}" file_content)
178 string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
179 string(REPLACE "\n" ";" valeur_line "${valeur_line}")
180 string(REPLACE "\n" ";" file_content "${file_content}")
182 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "\n") # make sure it exists
183 foreach(line ${file_content})
184 string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
185 string(REGEX MATCH ".*_toc.*" line3 "${line}")
186 if(line2 AND NOT line3)
187 string(REPLACE "\\section " "" line2 ${line2})
188 string(REPLACE "\\subsection " "subsection" line2 ${line2})
189 string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2})
190 string(REGEX REPLACE " .*" "" line2 ${line2})
191 set(line2 " - \\ref ${line2}")
192 string(REPLACE " - \\ref subsection" " - \\ref " line2 ${line2})
193 string(REPLACE " - \\ref subsubsection" " - \\ref " line2 ${line2})
194 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
195 endif(line2 AND NOT line3)
196 endforeach(line ${file_content})
198 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "\n") # make sure it exists
199 foreach(line ${valeur_line})
200 string(REGEX MATCH ".*ref.*" line_ok ${line})
202 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line_ok}\n")
204 endforeach(line ${valeur_line})
206 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
208 message(STATUS "Wrong toc for ${file_name}. Should be:")
209 file(READ "${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" file_content)
210 message("${file_content}")
211 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
213 endforeach(file_name ${LISTE_GTUT})
215 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
216 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
218 message(STATUS "Check main TOC")
220 foreach(file_name ${LISTE_GTUT})
221 file(READ "${file_name}" file_content)
222 string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
223 string(REPLACE "\n" ";" valeur_line "${valeur_line}")
224 string(REPLACE "\n" ";" file_content "${file_content}")
226 foreach(line ${file_content})
227 string(REGEX MATCH ".*@page.*" line2 "${line}")
229 string(REPLACE "@page " "" line2 "${line2}")
230 string(REGEX REPLACE " .*" "" line2 "${line2}")
231 set(line2 " - \\ref ${line2}")
232 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
234 endforeach(line ${file_content})
236 foreach(line ${valeur_line})
237 string(REGEX MATCH ".*toc.*" line1 "${line}")
238 string(REGEX MATCH ".*<hr>.*" line2 "${line}")
239 string(REGEX MATCH "^[ ]*$" line3 "${line}")
240 string(REGEX MATCH "Table of Contents" line4 "${line}")
241 if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
242 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc " ${line}\n")
243 endif(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
244 endforeach(line ${valeur_line})
245 endforeach(file_name ${LISTE_GTUT})
247 file(READ "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour.doc" file_content)
248 string(REPLACE "\n" ";" file_content "${file_content}")
249 foreach(line ${file_content})
250 string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}")
252 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line}\n")
254 endforeach(line ${file_content})
256 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
258 message(STATUS "Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
259 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
261 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
264 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
266 ADD_CUSTOM_TARGET(pdf
267 COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
269 COMMAND make pdf || true
270 COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
271 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
272 COMMAND make pdf || true
273 COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
274 COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
276 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
278 add_dependencies(pdf simgrid_documentation)