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