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 #DOC_SOURCE=doc/*.doc, defined in DefinePackage
31 set(DOCSSOURCES "${source_doxygen}\n${DOC_SOURCE}")
32 string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES})
36 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo.png
37 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
38 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_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
48 configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
49 configure_file(${CMAKE_HOME_DIRECTORY}/doc/footer.html.in ${CMAKE_HOME_DIRECTORY}/doc/footer.html @ONLY)
51 ADD_CUSTOM_TARGET(simgrid_documentation
52 COMMENT "Generating the SimGrid documentation..."
53 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
54 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
55 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/html
56 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
57 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
61 OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
62 DEPENDS ${source_doxygen}
63 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
64 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
65 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}
68 foreach(file ${DOC_FIGS})
69 string(REPLACE ".fig" ".png" tmp_file ${file})
70 string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
71 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
72 COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng ${file} ${tmp_file}
74 endforeach(file ${DOC_FIGS})
76 foreach(file ${DOC_PNGS})
77 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
78 COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
80 endforeach(file ${DOC_PNGS})
82 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
83 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/
84 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/
85 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png ${CMAKE_HOME_DIRECTORY}/doc/html/
86 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png ${CMAKE_HOME_DIRECTORY}/doc/html/
87 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/AS_hierarchy.png ${CMAKE_HOME_DIRECTORY}/doc/html/
88 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/
91 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
92 COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
93 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
94 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
95 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
97 COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
98 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
100 COMMAND ${CMAKE_COMMAND} -E echo "XX Post-processing Doxygen result"
101 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir*
102 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl
104 COMMAND ${CMAKE_COMMAND} -E echo "XX Create shortcuts pages"
105 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
106 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
108 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
109 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
111 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
112 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
114 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
115 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
116 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/
119 else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION)
121 ADD_CUSTOM_TARGET(simgrid_documentation
122 COMMENT "Generating the SimGrid documentation..."
125 if(NOT GOOD_BIBTEX2HTML_VERSION) # wrong version
126 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
127 COMMAND ${CMAKE_COMMAND} -E echo "This is not the good bibtex2html program !!!"
128 COMMAND ${CMAKE_COMMAND} -E echo "You can download it from:"
129 COMMAND ${CMAKE_COMMAND} -E echo " ftp://ftp-sop.inria.fr/epidaure/Softs/bibtex2html/bibtex2html-1.02.tar.gz"
130 COMMAND ${CMAKE_COMMAND} -E echo "There is also an unofficial Debian/Ubuntu package, see:"
131 COMMAND ${CMAKE_COMMAND} -E echo " http://www.loria.fr/~lnussbau/bibtex2html/README"
133 endif(NOT GOOD_BIBTEX2HTML_VERSION)
135 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
136 COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH = ${DOXYGEN_PATH}"
137 COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH = ${FIG2DEV_PATH}"
138 COMMAND ${CMAKE_COMMAND} -E echo "BIBTEX2HTML_PATH = ${BIBTEX2HTML_PATH}"
139 COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
140 COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..."
145 endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION)
147 ##############################################################################"
149 message(STATUS "Check individual TOCs")
151 doc/gtut-tour-00-install.doc
152 doc/gtut-tour-01-bones.doc
153 doc/gtut-tour-02-simple.doc
154 doc/gtut-tour-03-args.doc
155 doc/gtut-tour-04-callback.doc
156 doc/gtut-tour-05-globals.doc
157 doc/gtut-tour-06-logs.doc
158 doc/gtut-tour-07-timers.doc
159 doc/gtut-tour-08-exceptions.doc
160 doc/gtut-tour-09-simpledata.doc
161 doc/gtut-tour-10-rpc.doc
162 doc/gtut-tour-11-explicitwait.doc
163 doc/gtut-tour-recap-messages.doc
164 doc/gtut-tour-12-staticstruct.doc
165 doc/gtut-tour-13-pointers.doc
166 doc/gtut-tour-14-dynar.doc
167 doc/gtut-tour-15-manualdatadef.doc
168 doc/gtut-tour-16-exchangecb.doc
171 foreach(file_name ${LISTE_GTUT})
172 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
173 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
175 file(READ "${file_name}" file_content)
176 string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
177 string(REPLACE "\n" ";" valeur_line "${valeur_line}")
178 string(REPLACE "\n" ";" file_content "${file_content}")
180 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "\n") # make sure it exists
181 foreach(line ${file_content})
182 string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
183 string(REGEX MATCH ".*_toc.*" line3 "${line}")
184 if(line2 AND NOT line3)
185 string(REPLACE "\\section " "" line2 ${line2})
186 string(REPLACE "\\subsection " "subsection" line2 ${line2})
187 string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2})
188 string(REGEX REPLACE " .*" "" line2 ${line2})
189 set(line2 " - \\ref ${line2}")
190 string(REPLACE " - \\ref subsection" " - \\ref " line2 ${line2})
191 string(REPLACE " - \\ref subsubsection" " - \\ref " line2 ${line2})
192 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
193 endif(line2 AND NOT line3)
194 endforeach(line ${file_content})
196 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "\n") # make sure it exists
197 foreach(line ${valeur_line})
198 string(REGEX MATCH ".*ref.*" line_ok ${line})
200 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line_ok}\n")
202 endforeach(line ${valeur_line})
204 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
206 message(STATUS "Wrong toc for ${file_name}. Should be:")
207 file(READ "${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" file_content)
208 message("${file_content}")
209 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
211 endforeach(file_name ${LISTE_GTUT})
213 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
214 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
216 message(STATUS "Check main TOC")
218 foreach(file_name ${LISTE_GTUT})
219 file(READ "${file_name}" file_content)
220 string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
221 string(REPLACE "\n" ";" valeur_line "${valeur_line}")
222 string(REPLACE "\n" ";" file_content "${file_content}")
224 foreach(line ${file_content})
225 string(REGEX MATCH ".*@page.*" line2 "${line}")
227 string(REPLACE "@page " "" line2 "${line2}")
228 string(REGEX REPLACE " .*" "" line2 "${line2}")
229 set(line2 " - \\ref ${line2}")
230 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
232 endforeach(line ${file_content})
234 foreach(line ${valeur_line})
235 string(REGEX MATCH ".*toc.*" line1 "${line}")
236 string(REGEX MATCH ".*<hr>.*" line2 "${line}")
237 string(REGEX MATCH "^[ ]*$" line3 "${line}")
238 string(REGEX MATCH "Table of Contents" line4 "${line}")
239 if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
240 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc " ${line}\n")
241 endif(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
242 endforeach(line ${valeur_line})
243 endforeach(file_name ${LISTE_GTUT})
245 file(READ "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour.doc" file_content)
246 string(REPLACE "\n" ";" file_content "${file_content}")
247 foreach(line ${file_content})
248 string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}")
250 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line}\n")
252 endforeach(line ${file_content})
254 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
256 message(STATUS "Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
257 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
259 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
262 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
264 ADD_CUSTOM_TARGET(pdf
265 COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
267 COMMAND make pdf || true
268 COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
269 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
270 COMMAND make pdf || true
271 COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
272 COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
274 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
276 add_dependencies(pdf simgrid_documentation)