buildtools/Cmake/GenerateDoc.cmake

   1 #### Generate the whole html documentation
   2
   3 find_path(DOXYGEN_PATH  NAMES doxygen  PATHS NO_DEFAULT_PATHS)
   4 find_path(FIG2DEV_PATH  NAMES fig2dev  PATHS NO_DEFAULT_PATHS)
   5
   6 if(DOXYGEN_PATH)
   7
   8   ADD_CUSTOM_TARGET(simgrid_documentation
   9     COMMENT "Generating the SimGrid documentation..."
  10     DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
  11     COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
  12     COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_HOME_DIRECTORY}/doc/html
  13     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  14     )
  15
  16   execute_process(COMMAND ${DOXYGEN_PATH}/doxygen --version OUTPUT_VARIABLE DOXYGEN_VERSION )
  17   string(REGEX MATCH "^[0-9]" DOXYGEN_MAJOR_VERSION "${DOXYGEN_VERSION}")
  18   string(REGEX MATCH "^[0-9].[0-9]" DOXYGEN_MINOR_VERSION "${DOXYGEN_VERSION}")
  19   string(REGEX MATCH "^[0-9].[0-9].[0-9]" DOXYGEN_PATCH_VERSION "${DOXYGEN_VERSION}")
  20   string(REGEX REPLACE "^${DOXYGEN_MINOR_VERSION}." "" DOXYGEN_PATCH_VERSION "${DOXYGEN_PATCH_VERSION}")
  21   string(REGEX REPLACE "^${DOXYGEN_MAJOR_VERSION}." "" DOXYGEN_MINOR_VERSION "${DOXYGEN_MINOR_VERSION}")
  22   message(STATUS "Doxygen version : ${DOXYGEN_MAJOR_VERSION}.${DOXYGEN_MINOR_VERSION}.${DOXYGEN_PATCH_VERSION}")
  23
  24   if(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
  25     ADD_CUSTOM_TARGET(error_doxygen
  26       COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation"
  27       COMMAND false
  28     )
  29
  30     add_dependencies(simgrid_documentation error_doxygen)
  31   endif()
  32
  33   configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
  34
  35   foreach(file ${DOC_IMG})
  36     ADD_CUSTOM_COMMAND(
  37       TARGET simgrid_documentation
  38       COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
  39     )
  40   endforeach()
  41
  42   ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  43     COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/shared/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
  44     COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen"
  45     COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
  46     COMMAND ${CMAKE_COMMAND} -E echo "XX Generate the index files"
  47     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
  48     COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc
  49     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc
  50     COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen again"
  51     COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
  52     COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map
  53     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  54     )
  55
  56   ADD_CUSTOM_TARGET(pdf
  57     COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
  58     COMMAND make clean
  59     COMMAND make pdf || true
  60     COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
  61     COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
  62     COMMAND make pdf || true
  63     COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
  64     COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
  65     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
  66     )
  67   add_dependencies(pdf simgrid_documentation)
  68
  69
  70 endif()
  71
  72 #############################################
  73 ### Fill in the "make sync-gforge" target ###
  74 #############################################
  75
  76 add_custom_target(sync-gforge-doc
  77   COMMAND chmod g+rw -R doc/
  78   COMMAND chmod a+rX -R doc/
  79   COMMAND ssh scm.gforge.inria.fr mkdir -p /home/groups/simgrid/htdocs/simgrid/${release_version}/html/ || true
  80
  81   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
  82   doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true
  83
  84   COMMAND scp doc/html/simgrid_modules2.png doc/html/simgrid_modules.png doc/webcruft/simgrid_logo_2011.png
  85   doc/webcruft/simgrid_logo_2011_small.png scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/
  86   WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
  87   )
  88 add_dependencies(sync-gforge-doc simgrid_documentation)
  89
  90 add_custom_target(sync-gforge-dtd
  91   COMMAND scp src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/simgrid.dtd
  92   COMMAND scp src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid.dtd
  93   WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
  94   )
  95