buildtools/Cmake/GenerateRefGuide.cmake

   1 #### Generate the html documentation
   2
   3 file(GLOB_RECURSE source_doxygen
   4   "${CMAKE_HOME_DIRECTORY}/src/*.[chl]"
   5   "${CMAKE_HOME_DIRECTORY}/include/*.[chl]"
   6   )
   7
   8 if(FIG2DEV_PATH)
   9
  10   set(DOC_PNGS
  11     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
  12     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png
  13     )
  14
  15   configure_file(${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen/RefGuideDoxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen/RefGuideDoxyfile @ONLY)
  16
  17   ADD_CUSTOM_TARGET(ref_guide
  18     COMMENT "Generating the SimGrid ref guide..."
  19     DEPENDS ${REF_GUIDE_SOURCES} ${DOC_FIGS} ${source_doxygen}
  20     COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html
  21     COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html
  22     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/
  23     )
  24
  25   ADD_CUSTOM_COMMAND(TARGET ref_guide
  26     DEPENDS ${source_doxygen}
  27     COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen/logcategories.doc
  28     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen/logcategories.doc
  29     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}
  30     )
  31
  32   foreach(file ${DOC_FIGS})
  33     string(REPLACE ".fig" ".png" tmp_file ${file})
  34     string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html/" tmp_file ${tmp_file})
  35     ADD_CUSTOM_COMMAND(TARGET ref_guide
  36       COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file}
  37       )
  38   endforeach(file ${DOC_FIGS})
  39
  40   foreach(file ${DOC_PNGS})
  41     ADD_CUSTOM_COMMAND(TARGET ref_guide
  42       COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html/
  43       )
  44   endforeach(file ${DOC_PNGS})
  45
  46   ADD_CUSTOM_COMMAND(TARGET ref_guide
  47     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css                          ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html/
  48     )
  49
  50   ADD_CUSTOM_COMMAND(TARGET ref_guide
  51     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/ref_guide/doxygen/simgrid_modules.map
  52     COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
  53     COMMAND ${DOXYGEN_PATH}/doxygen RefGuideDoxyfile
  54     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl ../../shared/doxygen/simgridrefguide.tag index-API.doc
  55
  56     COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
  57     COMMAND ${DOXYGEN_PATH}/doxygen RefGuideDoxyfile
  58
  59     COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html/dir*
  60
  61     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen
  62     )
  63
  64 else()
  65
  66   ADD_CUSTOM_TARGET(ref_guide
  67     COMMENT "Generating the SimGrid documentation..."
  68     )
  69
  70   ADD_CUSTOM_COMMAND(TARGET ref_guide
  71     COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH     = ${DOXYGEN_PATH}"
  72     COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH     = ${FIG2DEV_PATH}"
  73     COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
  74     COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..."
  75     COMMAND false
  76     )
  77
  78 endif()
  79
  80 ##############################################################################"
  81
  82 ADD_CUSTOM_TARGET(ref_guide_pdf
  83     COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
  84     COMMAND make clean
  85     COMMAND make pdf || true
  86     COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
  87     COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
  88     COMMAND make pdf || true
  89     COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
  90     COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
  91
  92     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
  93 )
  94 add_dependencies(ref_guide_pdf ref_guide)