tools/cmake/GenerateDoc.cmake

   1 #### Generate the whole html documentation
   2
   3 if (enable_documentation)
   4   find_package(Doxygen REQUIRED)
   5   set(DocAll "ALL")
   6 else()
   7   find_package(Doxygen)
   8 endif()
   9
  10 if (HAVE_Java)
  11   find_path(JAVADOC_PATH  NAMES javadoc   PATHS NO_DEFAULT_PATHS)
  12   mark_as_advanced(JAVADOC_PATH)
  13 endif()
  14
  15 find_path(FIG2DEV_PATH  NAMES fig2dev  PATHS NO_DEFAULT_PATHS)
  16
  17
  18 if(DOXYGEN_FOUND)
  19
  20   ADD_CUSTOM_TARGET(doc ${DocAll}
  21     COMMENT "Generating the SimGrid documentation..."
  22     DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
  23     COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
  24     COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_HOME_DIRECTORY}/doc/html
  25     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  26     )
  27
  28   message(STATUS "Doxygen version: ${DOXYGEN_VERSION}")
  29
  30   # This is a workaround for older cmake versions
  31   # (such as 2.8.7 on Ubuntu 12.04). These cmake versions do not provide the
  32   # DOXYGEN_VERSION variable and hence, building the documentation will always
  33   # fail. This code is the same as used in the cmake library, version 3.
  34   if(DOXYGEN_EXECUTABLE)
  35     execute_process(COMMAND ${DOXYGEN_EXECUTABLE} "--version" OUTPUT_VARIABLE DOXYGEN_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE)
  36   endif()
  37
  38   if(DOXYGEN_VERSION VERSION_LESS "1.8")
  39     ADD_CUSTOM_TARGET(error_doxygen
  40         COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation. Version found: ${DOXYGEN_VERSION}"
  41       COMMAND false
  42     )
  43
  44     add_dependencies(doc error_doxygen)
  45   endif()
  46
  47   configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
  48
  49   foreach(file ${DOC_FIGS})
  50     string(REPLACE ".fig" ".png" tmp_file ${file})
  51     string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
  52     ADD_CUSTOM_COMMAND(TARGET doc
  53       COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file}
  54       )
  55   endforeach()
  56
  57   foreach(file ${DOC_IMG})
  58     ADD_CUSTOM_COMMAND(
  59       TARGET doc
  60       COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
  61     )
  62   endforeach()
  63
  64   ADD_CUSTOM_COMMAND(TARGET doc
  65     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
  66     COMMAND pwd
  67     COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen"
  68     COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile
  69     COMMAND ${CMAKE_COMMAND} -E echo "XX Generate the index files"
  70     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
  71     COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc
  72     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc
  73     COMMAND ${CMAKE_COMMAND} -E echo "XX Generate list of files in examples/ for routing models"
  74     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh Floyd > ${CMAKE_HOME_DIRECTORY}/doc/example_lists/example_filelist_routing_floyd
  75     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh Dijkstra > ${CMAKE_HOME_DIRECTORY}/doc/example_lists/example_filelist_routing_dijkstra
  76     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh DijkstraCache > ${CMAKE_HOME_DIRECTORY}/doc/example_lists/example_filelist_routing_dijkstra_cache
  77     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh 'routing="None"' > ${CMAKE_HOME_DIRECTORY}/doc/example_lists/example_filelist_routing_none
  78     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh 'routing="Cluster"' > ${CMAKE_HOME_DIRECTORY}/doc/example_lists/example_filelist_routing_cluster
  79     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh 'routing="Vivaldi"' > ${CMAKE_HOME_DIRECTORY}/doc/example_lists/example_filelist_routing_vivaldi
  80     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh 'routing="Full"' > ${CMAKE_HOME_DIRECTORY}/doc/example_lists/example_filelist_routing_full
  81     COMMAND ${CMAKE_COMMAND} -E echo "XX Generate list of files in examples/ for XML tags"
  82     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh '<mount ' > ${CMAKE_HOME_DIRECTORY}/doc/example_lists/example_filelist_xmltag_mount
  83     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh '<link_ctn ' > ${CMAKE_HOME_DIRECTORY}/doc/example_lists/example_filelist_xmltag_linkctn
  84     COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen again"
  85     COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile
  86     COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map
  87     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  88     )
  89
  90    if (HAVE_Java)
  91       ADD_CUSTOM_COMMAND(TARGET doc
  92         COMMAND ${CMAKE_COMMAND} -E echo "XX Javadoc pass"
  93         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
  94         WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  95       )
  96    endif()
  97
  98
  99
 100
 101 #############################################
 102 ### Fill in the "make sync-gforge" target ###
 103 #############################################
 104
 105 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)
 106
 107 add_custom_target(sync-gforge-doc
 108   COMMAND ssh scm.gforge.inria.fr mkdir -p -m 2775 /home/groups/simgrid/htdocs/simgrid/${release_version}/ || true
 109
 110   COMMAND ${RSYNC_CMD} doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true
 111
 112   COMMAND ${RSYNC_CMD} doc/html/simgrid_modules2.png doc/html/simgrid_modules.png doc/webcruft/simgrid_logo_2011.png
 113   doc/webcruft/simgrid_logo_2011_small.png scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/
 114
 115   WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
 116   )
 117 add_dependencies(sync-gforge-doc doc)
 118
 119 add_custom_target(sync-gforge-dtd
 120   COMMAND ${RSYNC_CMD} src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/simgrid.dtd
 121   COMMAND ${RSYNC_CMD} src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid.dtd
 122   WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
 123   )
 124
 125 endif()
 126