X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/e77193834c70dfb7d82869defdeaeb494f17d083..2e1fd75de74f87793538f141d8b07ce652eae760:/buildtools/Cmake/GenerateDoc.cmake diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake index 1e152f7bc8..1cbc2b9670 100644 --- a/buildtools/Cmake/GenerateDoc.cmake +++ b/buildtools/Cmake/GenerateDoc.cmake @@ -1,274 +1,106 @@ -#### Generate the html documentation +#### Generate the whole html documentation + +if (enable_documentation) + find_package(Doxygen REQUIRED) + set(DocAll "ALL") +else() + find_package(Doxygen) +endif() + +find_path(JAVADOC_PATH NAMES javadoc PATHS NO_DEFAULT_PATHS) +find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS) +mark_as_advanced(JAVADOC_PATH) + +if(DOXYGEN_FOUND) + + ADD_CUSTOM_TARGET(doc ${DocAll} + 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 + WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc + ) + + message(STATUS "Doxygen version: ${DOXYGEN_VERSION}") + + # This is a workaround for older cmake versions + # (such as 2.8.7 on Ubuntu 12.04). These cmake versions do not provide the + # DOXYGEN_VERSION variable and hence, building the documentation will always + # fail. This code is the same as used in the cmake library, version 3. + if(DOXYGEN_EXECUTABLE) + execute_process(COMMAND ${DOXYGEN_EXECUTABLE} "--version" OUTPUT_VARIABLE DOXYGEN_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE) + endif() + + if(DOXYGEN_VERSION VERSION_LESS "1.8") + ADD_CUSTOM_TARGET(error_doxygen + COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation. Version found: ${DOXYGEN_VERSION}" + COMMAND false + ) + + add_dependencies(doc error_doxygen) + endif() + + configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY) + + foreach(file ${DOC_FIGS}) + string(REPLACE ".fig" ".png" tmp_file ${file}) + string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file}) + ADD_CUSTOM_COMMAND(TARGET doc + COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file} + ) + endforeach() + + foreach(file ${DOC_IMG}) + ADD_CUSTOM_COMMAND( + TARGET doc + COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/ + ) + endforeach() + + ADD_CUSTOM_COMMAND(TARGET doc + COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/shared/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/ ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map + COMMAND pwd + COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen" + COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile + COMMAND ${CMAKE_COMMAND} -E echo "XX Generate the index files" + COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc + COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc + COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc + COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen again" + COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile + COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map + COMMAND ${CMAKE_COMMAND} -E echo "XX Javadoc pass" + COMMAND ${JAVADOC_PATH}/javadoc -quiet -d ${CMAKE_HOME_DIRECTORY}/doc/html/javadoc/ ${CMAKE_HOME_DIRECTORY}/src/bindings/java/org/simgrid/*.java ${CMAKE_HOME_DIRECTORY}/src/bindings/java/org/simgrid/*/*.java + WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc + ) + + + + + +############################################# +### Fill in the "make sync-gforge" target ### +############################################# + +set(RSYNC_CMD rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --times --omit-dir-times --perms --chmod=a+rX,ug+w,o-w,Dg+s) + +add_custom_target(sync-gforge-doc + COMMAND ssh scm.gforge.inria.fr mkdir -p -m 2775 /home/groups/simgrid/htdocs/simgrid/${release_version}/ || true + + COMMAND ${RSYNC_CMD} doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true + + COMMAND ${RSYNC_CMD} doc/html/simgrid_modules2.png doc/html/simgrid_modules.png doc/webcruft/simgrid_logo_2011.png + doc/webcruft/simgrid_logo_2011_small.png scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/ + + WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}" + ) +add_dependencies(sync-gforge-doc doc) + +add_custom_target(sync-gforge-dtd + COMMAND ${RSYNC_CMD} src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/simgrid.dtd + COMMAND ${RSYNC_CMD} src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid.dtd + WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}" + ) + +endif() -if(BIBTEX2HTML) - set(BIBTEX2HTML_PATH ${BIBTEX2HTML}) -else(BIBTEX2HTML) - find_path(BIBTEX2HTML_PATH NAMES bibtex2html PATHS NO_DEFAULT_PATHS) -endif(BIBTEX2HTML) - -find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS) -find_path(DOXYGEN_PATH NAMES doxygen PATHS NO_DEFAULT_PATHS) - -### 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}) - -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 BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION) - - string(REGEX REPLACE ";.*logcategories.doc" "" LISTE_DEUX "${LISTE_DEUX}") - - #DOC_SOURCE=doc/*.doc, defined in DefinePackage - set(DOCSSOURCES "${source_doxygen}\n${DOC_SOURCE}") - string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES}) - - - set(DOC_PNGS - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_small.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_01.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_02.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_03.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_04.png - ) - - configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY) - 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 ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/ ${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} - COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc - WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY} - ) - - foreach(file ${DOC_FIGS}) - string(REPLACE ".fig" ".png" tmp_file ${file}) - string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file}) - ADD_CUSTOM_COMMAND(TARGET simgrid_documentation - COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng ${file} ${tmp_file} - ) - endforeach(file ${DOC_FIGS}) - - foreach(file ${DOC_PNGS}) - ADD_CUSTOM_COMMAND(TARGET simgrid_documentation - COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/ - ) - endforeach(file ${DOC_PNGS}) - - ADD_CUSTOM_COMMAND(TARGET simgrid_documentation - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/ - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/ - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png ${CMAKE_HOME_DIRECTORY}/doc/html/ - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png ${CMAKE_HOME_DIRECTORY}/doc/html/ - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/ - ) - - ADD_CUSTOM_COMMAND(TARGET simgrid_documentation - COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass" - COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl pls.doc index.doc gtut-introduction.doc installSimgrid.doc bindings.doc options.doc tracing.doc - - 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 remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir* - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl - - COMMAND ${CMAKE_COMMAND} -E echo "XX Create shortcuts pages" - COMMAND ${CMAKE_COMMAND} -E echo \"\" > ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html - COMMAND ${CMAKE_COMMAND} -E echo \"