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