tools/cmake/Documentation.cmake

   1 ###
   2 ### Generate all parts of the documentation on non-Windows systems
   3 ###
   4 ###   - HTML with doxygen (reference and manual)
   5 ###   - Javadoc (reference)
   6 ###   - manpages (reference of tools)
   7 ###
   8 ###  This file is not loaded on windows
   9
  10 #### Generate the html documentation
  11 if (enable_documentation)
  12   find_package(Doxygen REQUIRED)
  13 else()
  14   find_package(Doxygen)
  15 endif()
  16
  17 find_path(FIG2DEV_PATH  NAMES fig2dev  PATHS NO_DEFAULT_PATHS)
  18
  19 if(enable_documentation)
  20   ADD_CUSTOM_TARGET(documentation
  21     COMMENT "Generating the SimGrid documentation..."
  22     DEPENDS ${DOC_SOURCES} ${source_doxygen}
  23     COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_BINARY_DIR}/doc/doxygen
  24     COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_BINARY_DIR}/doc/example_lists
  25     COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_BINARY_DIR}/doc/html
  26     COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_BINARY_DIR}/doc/html
  27     COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_BINARY_DIR}/doc/xml
  28     COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_BINARY_DIR}/docs/source/api
  29     WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
  30   )
  31
  32   message(STATUS "Doxygen version: ${DOXYGEN_VERSION}")
  33
  34   if(DOXYGEN_VERSION VERSION_LESS "1.8")
  35     ADD_CUSTOM_TARGET(error_doxygen
  36         COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation. Version found: ${DOXYGEN_VERSION}"
  37       COMMAND false
  38     )
  39     add_dependencies(documentation error_doxygen)
  40   endif()
  41
  42   foreach(file ${DOC_IMG})
  43     ADD_CUSTOM_COMMAND(TARGET documentation COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_BINARY_DIR}/doc/html/)
  44   endforeach()
  45
  46   ADD_CUSTOM_COMMAND(TARGET documentation
  47     COMMAND pwd
  48     COMMAND ${CMAKE_COMMAND} -E echo "XX Generate list of files in examples/ for routing models"
  49     COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/doc/example_lists/
  50     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh Floyd > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_floyd
  51     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh Dijkstra > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_dijkstra
  52     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh DijkstraCache > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_dijkstra_cache
  53     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh 'routing="None"' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_none
  54     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh 'routing="Cluster"' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_cluster
  55     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh 'routing="Vivaldi"' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_vivaldi
  56     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh 'routing="Full"' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_full
  57     COMMAND ${CMAKE_COMMAND} -E echo "XX Generate list of files in examples/ for XML tags"
  58     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh '<mount ' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_xmltag_mount
  59     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh '<link_ctn ' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_xmltag_linkctn
  60     COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen"
  61     COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile
  62     WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
  63   )
  64
  65   if (Java_FOUND)
  66     find_path(JAVADOC_PATH  NAMES javadoc   PATHS NO_DEFAULT_PATHS)
  67     mark_as_advanced(JAVADOC_PATH)
  68
  69     ADD_CUSTOM_COMMAND(TARGET documentation
  70       COMMAND ${CMAKE_COMMAND} -E echo "XX Javadoc pass"
  71       COMMAND ${JAVADOC_PATH}/javadoc -quiet -d ${CMAKE_BINARY_DIR}/doc/html/javadoc/ ${CMAKE_HOME_DIRECTORY}/src/bindings/java/org/simgrid/*.java ${CMAKE_HOME_DIRECTORY}/src/bindings/java/org/simgrid/*/*.java
  72       WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
  73     )
  74   endif()
  75
  76   #### Generate the manpages
  77   if( NOT MANPAGE_DIR)
  78     set( MANPAGE_DIR ${CMAKE_BINARY_DIR}/manpages )
  79   endif()
  80
  81   add_custom_target(manpages ALL
  82     COMMAND ${CMAKE_COMMAND} -E make_directory ${MANPAGE_DIR}
  83     COMMAND pod2man ${CMAKE_HOME_DIRECTORY}/tools/simgrid_update_xml.pl > ${MANPAGE_DIR}/simgrid_update_xml.1
  84     COMMAND pod2man ${CMAKE_HOME_DIRECTORY}/docs/manpages/tesh.pod > ${MANPAGE_DIR}/tesh.1
  85     COMMENT "Generating manpages"
  86   )
  87   install(FILES
  88     ${MANPAGE_DIR}/simgrid_update_xml.1
  89     ${MANPAGE_DIR}/tesh.1
  90     ${CMAKE_HOME_DIRECTORY}/docs/manpages/smpicc.1
  91     ${CMAKE_HOME_DIRECTORY}/docs/manpages/smpicxx.1
  92     ${CMAKE_HOME_DIRECTORY}/docs/manpages/smpif90.1
  93     ${CMAKE_HOME_DIRECTORY}/docs/manpages/smpiff.1
  94     ${CMAKE_HOME_DIRECTORY}/docs/manpages/smpirun.1
  95     DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
  96   )
  97
  98 else(enable_documentation)
  99   ADD_CUSTOM_TARGET(documentation
 100     COMMENT "The generation of the SimGrid documentation was disabled in cmake"
 101   )
 102 endif(enable_documentation)