-message("\tBIBTEX2HTML : ${BIBTEX2HTML}")
+#### Generate the html documentation
if(BIBTEX2HTML)
-set(BIBTEX2HTML_PATH ${BIBTEX2HTML})
+ set(BIBTEX2HTML_PATH ${BIBTEX2HTML})
else(BIBTEX2HTML)
-find_path(BIBTEX2HTML_PATH NAMES bibtex2html PATHS NO_DEFAULT_PATHS)
+ find_path(BIBTEX2HTML_PATH NAMES bibtex2html PATHS NO_DEFAULT_PATHS)
endif(BIBTEX2HTML)
find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS)
find_path(BIBTOOL_PATH NAMES bibtool PATHS NO_DEFAULT_PATHS)
find_path(ICONV_PATH NAMES iconv PATHS NO_DEFAULT_PATHS)
-message("\tFIG2DEV_PATH : ${FIG2DEV_PATH}")
-message("\tDOXYGEN_PATH : ${DOXYGEN_PATH}")
-message("\tBIBTOOL_PATH : ${BIBTOOL_PATH}")
-message("\tICONV_PATH : ${ICONV_PATH}")
-message("\tBIBTEX2HTML_PATH : ${BIBTEX2HTML_PATH}")
-
### Check whether the bibtex2html that we found is the one that Arnaud requires
exec_program("${BIBTEX2HTML_PATH}/bibtex2html -version" OUTPUT_VARIABLE OUTPUT_BIBTEX2HTML_VERSION)
STRING(REPLACE "[-bibtex]" "" OUTPUT_BIBTEX2HTML_VERSION_2 ${OUTPUT_BIBTEX2HTML_VERSION})
-if(BIBTEX2HTML_PATH)
- if(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # wrong version
- message("\nERROR --> NEED to set bibtex2html path with \"ccmake ./\" or with \"cmake -DBIBTEX2HTML=<path_to> ./\"")
- message("\nTake care having install the good bibtex2html \n\t(download it : ftp://ftp-sop.inria.fr/epidaure/Softs/bibtex2html/bibtex2html-1.02.tar.gz)")
- message(FATAL_ERROR "\n")
- endif(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION})
-endif(BIBTEX2HTML_PATH)
-
-
file(GLOB_RECURSE source_doxygen
"${CMAKE_HOME_DIRECTORY}/tools/gras/*.[chl]"
"${CMAKE_HOME_DIRECTORY}/src/*.[chl]"
"${CMAKE_HOME_DIRECTORY}/include/*.[chl]"
)
+if(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # wrong version
+ SET(GOOD_BIBTEX2HTML_VERSION 0)
+else(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # good version
+ SET(GOOD_BIBTEX2HTML_VERSION 1)
+endif(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION})
-if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH)
+if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION)
string(REGEX REPLACE ";.*logcategories.doc" "" LISTE_DEUX "${LISTE_DEUX}")
${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_small.png
${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png
)
- message("WARNING = ${WARNING}")
- message("srcdir = ${srcdir}")
- message("top_srcdir = ${top_srcdir}")
configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
-
- ADD_CUSTOM_TARGET(simgrid_documentation ALL
+ configure_file(${CMAKE_HOME_DIRECTORY}/doc/footer.html.in ${CMAKE_HOME_DIRECTORY}/doc/footer.html @ONLY)
+
+ ADD_CUSTOM_TARGET(simgrid_documentation
COMMENT "Generating the SimGrid documentation..."
DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
- COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/html
-
+ COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/html
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
-
WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
)
-
+
ADD_CUSTOM_COMMAND(
OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
DEPENDS ${source_doxygen}
)
ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
+ COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
- COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
- COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl FAQ.doc index.doc contrib.doc gtut-introduction.doc history.doc
+ COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl index.doc gtut-introduction.doc installSimgrid.doc bindings.doc options.doc
- COMMAND ${CMAKE_COMMAND} -E echo XX Second Doxygen pass
+ COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
- COMMAND ${CMAKE_COMMAND} -E echo XX Post-processing Doxygen result
+ COMMAND ${CMAKE_COMMAND} -E echo "XX Post-processing Doxygen result"
COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir*
- COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_php.pl index.php.in html/index.html index.php
COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl
-
- COMMAND ${CMAKE_COMMAND} -E echo XX Create shortcuts pages
+
+ COMMAND ${CMAKE_COMMAND} -E echo "XX Create shortcuts pages"
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
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
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
WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/
)
-
- ADD_CUSTOM_COMMAND(
- OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/publis_count.html
- DEPENDS all.bib
- COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_table_count.pl < ${CMAKE_HOME_DIRECTORY}/doc/all.bib > ${CMAKE_HOME_DIRECTORY}/doc/publis_count.html
- )
- add_dependencies(simgrid_documentation ${CMAKE_HOME_DIRECTORY}/doc/publis_count.html)
+else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION)
- ADD_CUSTOM_COMMAND(
- OUTPUT publis_core.bib publis_extern.bib publis_intra.bib
- DEPENDS all.bib
+ ADD_CUSTOM_TARGET(simgrid_documentation
+ COMMENT "Generating the SimGrid documentation..."
+ )
- COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category "core"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' ${CMAKE_HOME_DIRECTORY}/doc/all.bib -o ${CMAKE_HOME_DIRECTORY}/doc/publis_core.bib
- COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category "extern"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' ${CMAKE_HOME_DIRECTORY}/doc/all.bib -o ${CMAKE_HOME_DIRECTORY}/doc/publis_extern.bib
- COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category "intra"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' ${CMAKE_HOME_DIRECTORY}/doc/all.bib -o ${CMAKE_HOME_DIRECTORY}/doc/publis_intra.bib
- )
+ if(NOT GOOD_BIBTEX2HTML_VERSION) # wrong version
+ ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
+ COMMAND ${CMAKE_COMMAND} -E echo "This is not the good bibtex2html program !!!"
+ COMMAND ${CMAKE_COMMAND} -E echo "You can download it from:"
+ COMMAND ${CMAKE_COMMAND} -E echo " ftp://ftp-sop.inria.fr/epidaure/Softs/bibtex2html/bibtex2html-1.02.tar.gz"
+ COMMAND ${CMAKE_COMMAND} -E echo "There is also an unofficial Debian/Ubuntu package, see:"
+ COMMAND ${CMAKE_COMMAND} -E echo " http://www.loria.fr/~lnussbau/bibtex2html/README"
+ )
+ endif(NOT GOOD_BIBTEX2HTML_VERSION)
- foreach(file "publis_core publis_extern publis_intra")
- ADD_CUSTOM_COMMAND(
- OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/${file}.html
- DEPENDS "${file}.bib"
-
- COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl ${file}
- )
+ ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
+ COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH = ${DOXYGEN_PATH}"
+ COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH = ${FIG2DEV_PATH}"
+ COMMAND ${CMAKE_COMMAND} -E echo "BIBTOOL_PATH = ${BIBTOOL_PATH}"
+ COMMAND ${CMAKE_COMMAND} -E echo "BIBTEX2HTML_PATH = ${BIBTEX2HTML_PATH}"
+ COMMAND ${CMAKE_COMMAND} -E echo "ICONV_PATH = ${ICONV_PATH}"
+ COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
+ COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..."
+ COMMAND false
+ )
- add_dependencies(simgrid_documentation ${CMAKE_HOME_DIRECTORY}/doc/${file}.html)
- endforeach(file "publis_core publis_extern publis_intra")
-
-else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH)
- message(FATAL_ERROR "You asked to regenerate the documentation, but you are missing some build-dependencies. Please install them, or change enable_doc to OFF")
+
+endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION)
-endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH)
+##############################################################################"
-message("Check individual TOCs")
-file(GLOB_RECURSE LISTE_GTUT
- "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour-*.doc"
+message(STATUS "Check individual TOCs")
+set(LISTE_GTUT
+ doc/gtut-tour-00-install.doc
+ doc/gtut-tour-01-bones.doc
+ doc/gtut-tour-02-simple.doc
+ doc/gtut-tour-03-args.doc
+ doc/gtut-tour-04-callback.doc
+ doc/gtut-tour-05-globals.doc
+ doc/gtut-tour-06-logs.doc
+ doc/gtut-tour-07-timers.doc
+ doc/gtut-tour-08-exceptions.doc
+ doc/gtut-tour-09-simpledata.doc
+ doc/gtut-tour-10-rpc.doc
+ doc/gtut-tour-11-explicitwait.doc
+ doc/gtut-tour-recap-messages.doc
+ doc/gtut-tour-12-staticstruct.doc
+ doc/gtut-tour-13-pointers.doc
+ doc/gtut-tour-14-dynar.doc
+ doc/gtut-tour-15-manualdatadef.doc
+ doc/gtut-tour-16-exchangecb.doc
)
+
foreach(file_name ${LISTE_GTUT})
file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
string(REPLACE "\n" ";" valeur_line "${valeur_line}")
string(REPLACE "\n" ";" file_content "${file_content}")
-
+
+ file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "\n") # make sure it exists
foreach(line ${file_content})
string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
string(REGEX MATCH ".*_toc.*" line3 "${line}")
endif(line2 AND NOT line3)
endforeach(line ${file_content})
+ file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "\n") # make sure it exists
foreach(line ${valeur_line})
string(REGEX MATCH ".*ref.*" line_ok ${line})
if(line_ok)
exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
if(compare_files)
- message("Wrong toc for ${file_name}. Should be:")
+ message(STATUS "Wrong toc for ${file_name}. Should be:")
file(READ "${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" file_content)
message("${file_content}")
exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
-message("Check main TOC")
+message(STATUS "Check main TOC")
foreach(file_name ${LISTE_GTUT})
file(READ "${file_name}" file_content)
exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
if(compare_files)
- message("Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
+ message(STATUS "Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
else(compare_files)
file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
endif(compare_files)
-file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
\ No newline at end of file
+file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
+
+#Website
+
+configure_file(${CMAKE_HOME_DIRECTORY}/website/Doxyfile_website.in ${CMAKE_HOME_DIRECTORY}/website/Doxyfile_website @ONLY)
+configure_file(${CMAKE_HOME_DIRECTORY}/website/index.php.in ${CMAKE_HOME_DIRECTORY}/website/html/index.php @ONLY)
+configure_file(${CMAKE_HOME_DIRECTORY}/website/documentation.php.in ${CMAKE_HOME_DIRECTORY}/website/html/documentation.php @ONLY)
+configure_file(${CMAKE_HOME_DIRECTORY}/website/download.php.in ${CMAKE_HOME_DIRECTORY}/website/html/download.php @ONLY)
+
+ADD_CUSTOM_TARGET(simgrid_website
+ COMMENT "Generating the SimGrid Website..."
+ DEPENDS ${WEBSITE_SOURCES} ${CMAKE_HOME_DIRECTORY}/website/all.bib
+ COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl FAQ.doc contrib.doc history.doc
+ COMMAND ${CMAKE_COMMAND} -E echo "XX Doxygen website pass"
+ COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile_website
+
+ COMMAND ${CMAKE_COMMAND} -E echo "XX Post-processing Doxygen website result"
+ COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/doxygen_postprocesser_website.pl
+
+ COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_HOME_DIRECTORY}/website/stylesheets/ ${CMAKE_HOME_DIRECTORY}/website/html/stylesheets/
+ COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_HOME_DIRECTORY}/website/logos/ ${CMAKE_HOME_DIRECTORY}/website/html/logos/
+ COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_HOME_DIRECTORY}/website/img/ ${CMAKE_HOME_DIRECTORY}/website/html/img/
+ COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/website/documentation.html ${CMAKE_HOME_DIRECTORY}/website/html/documentation.html
+
+ COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/website/html/index.html
+
+ WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/website/
+)
+
+ADD_CUSTOM_TARGET(bib_files
+ DEPENDS ${CMAKE_HOME_DIRECTORY}/website/all.bib
+ COMMAND ${CMAKE_COMMAND} -E echo "XX Generate publis_core.bib publis_extern.bib publis_intra.bib"
+ COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category \"core\"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' all.bib -o publis_core.bib
+ COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category \"extern\"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' all.bib -o publis_extern.bib
+ COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category \"intra\"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' all.bib -o publis_intra.bib
+
+ COMMAND ${CMAKE_COMMAND} -E echo "XX Generate publis_count.html"
+ COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_table_count.pl < ${CMAKE_HOME_DIRECTORY}/website/all.bib > ${CMAKE_HOME_DIRECTORY}/website/publis_count.html
+
+ COMMAND ${CMAKE_COMMAND} -E echo "XX Generate publis_core.html publis_extern.html publis_intra.html"
+ COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl publis_core
+ COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl publis_extern
+ COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl publis_intra
+ WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/website/
+)
+
+add_dependencies(simgrid_website bib_files)
+
+ADD_CUSTOM_TARGET(pdf
+ COMMAND ${CMAKE_COMMAND} -E echo "XX Generate simgrid_documentation.pdf"
+ COMMAND make clean
+ COMMAND make pdf
+ COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
+ WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex
+)
+add_dependencies(pdf simgrid_documentation)
