buildtools/Cmake/GenerateDoc.cmake

   1 #### Generate the whole html documentation
   2
   3 find_path(DOXYGEN_PATH  NAMES doxygen   PATHS NO_DEFAULT_PATHS)
   4
   5 if(DOXYGEN_PATH)
   6 execute_process(
   7         COMMAND ${DOXYGEN_PATH}/doxygen --version
   8         RESULT_VARIABLE DOXYGEN_VERSION
   9         )
  10 message(STATUS "${DOXYGEN_PATH}/doxygen --version Doxygen version : ${DOXYGEN_VERSION}")
  11 string(REGEX MATCH "^[0-9]" DOXYGEN_MAJOR_VERSION "${DOXYGEN_VERSION}")
  12 string(REGEX MATCH "^[0-9].[0-9]" DOXYGEN_MINOR_VERSION "${DOXYGEN_VERSION}")
  13 string(REGEX MATCH "^[0-9].[0-9].[0-9]" DOXYGEN_PATCH_VERSION "${DOXYGEN_VERSION}")
  14 string(REGEX REPLACE "^${DOXYGEN_MINOR_VERSION}." "" DOXYGEN_PATCH_VERSION "${DOXYGEN_PATCH_VERSION}")
  15 string(REGEX REPLACE "^${DOXYGEN_MAJOR_VERSION}." "" DOXYGEN_MINOR_VERSION "${DOXYGEN_MINOR_VERSION}")
  16 message(STATUS "Doxygen version : ${DOXYGEN_MAJOR_VERSION}.${DOXYGEN_MINOR_VERSION}")
  17                 set(DOC_PNGS
  18                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
  19                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png
  20         )
  21
  22         configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
  23
  24         ADD_CUSTOM_TARGET(simgrid_documentation
  25                 COMMENT "Generating the SimGrid documentation..."
  26                 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
  27                 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
  28             COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_HOME_DIRECTORY}/doc/html
  29                 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  30         )
  31         add_dependencies(simgrid_documentation ref_guide)
  32         add_dependencies(simgrid_documentation user_guide)
  33         foreach(file ${DOC_PNGS})
  34                 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  35                         COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
  36                 )
  37         endforeach(file ${DOC_PNGS})
  38
  39         ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  40                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/
  41         )
  42
  43         ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  44             COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
  45                 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
  46         WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  47         )
  48
  49 endif(DOXYGEN_PATH)
  50 ADD_CUSTOM_TARGET(pdf
  51     COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
  52     COMMAND make clean
  53     COMMAND make pdf || true
  54     COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
  55     COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
  56     COMMAND make pdf || true
  57     COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
  58     COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
  59
  60     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
  61 )
  62 add_dependencies(pdf simgrid_documentation)