buildtools/Cmake/GenerateRefGuide.cmake

   1 #### Generate the html documentation
   2
   3 find_path(FIG2DEV_PATH  NAMES fig2dev   PATHS NO_DEFAULT_PATHS)
   4 find_path(DOXYGEN_PATH  NAMES doxygen   PATHS NO_DEFAULT_PATHS)
   5
   6
   7 file(GLOB_RECURSE source_doxygen
   8         "${CMAKE_HOME_DIRECTORY}/tools/gras/*.[chl]"
   9         "${CMAKE_HOME_DIRECTORY}/src/*.[chl]"
  10         "${CMAKE_HOME_DIRECTORY}/include/*.[chl]"
  11 )
  12
  13
  14 if(DOXYGEN_PATH AND FIG2DEV_PATH)
  15
  16         #DOC_SOURCE=doc/*.doc, defined in DefinePackage
  17         set(DOCSSOURCES "${source_doxygen}\n${DOC_SOURCE}")
  18         string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES})
  19
  20
  21         set(DOC_PNGS
  22                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
  23                 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_small.png
  24         )
  25
  26         configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
  27         configure_file(${CMAKE_HOME_DIRECTORY}/doc/footer.html.in ${CMAKE_HOME_DIRECTORY}/doc/footer.html @ONLY)
  28
  29         ADD_CUSTOM_TARGET(ref_guide
  30                 COMMENT "Generating the SimGrid ref guide..."
  31                 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
  32                 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html
  33             COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html
  34                 COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/<IMG/<IMG style=border:0px/g' > ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map
  35                 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  36         )
  37
  38         ADD_CUSTOM_COMMAND(
  39                 OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
  40                 DEPENDS ${source_doxygen}
  41                 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
  42                 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
  43                 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}
  44         )
  45
  46         foreach(file ${DOC_FIGS})
  47                 string(REPLACE ".fig" ".png" tmp_file ${file})
  48                 string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
  49                 ADD_CUSTOM_COMMAND(TARGET ref_guide
  50                         COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file}
  51                 )
  52         endforeach(file ${DOC_FIGS})
  53
  54         foreach(file ${DOC_PNGS})
  55                 ADD_CUSTOM_COMMAND(TARGET ref_guide
  56                         COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
  57                 )
  58         endforeach(file ${DOC_PNGS})
  59
  60         ADD_CUSTOM_COMMAND(TARGET ref_guide
  61                 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css                          ${CMAKE_HOME_DIRECTORY}/doc/html/
  62         )
  63
  64         ADD_CUSTOM_COMMAND(TARGET ref_guide
  65             COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
  66                 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
  67                 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
  68
  69                 COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
  70                 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
  71
  72                 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir*
  73
  74                 COMMAND ${CMAKE_COMMAND} -E echo "XX Create shortcuts pages"
  75                 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__GRAS__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html
  76                 COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__GRAS__API.html'>Grid Reality And Simulation.</a></h2></center></html>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html
  77
  78                 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__AMOK__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/amok.html
  79                 COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__AMOK__API.html'>Advanced Metacomputing Overlay Kit.</a></h2></center></html>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/amok.html
  80
  81                 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__MSG__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/msg.html
  82                 COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__MSG__API.html'>Meta SimGrid.</a></h2></center></html>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/msg.html
  83
  84                 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__SD__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/simdag.html
  85                 COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__SD__API.html'>DAG Simulator.</a></h2></center></html>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/simdag.html
  86                 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/
  87         )
  88
  89 else(DOXYGEN_PATH AND FIG2DEV_PATH)
  90
  91         ADD_CUSTOM_TARGET(ref_guide
  92                         COMMENT "Generating the SimGrid documentation..."
  93                         )
  94
  95         ADD_CUSTOM_COMMAND(TARGET ref_guide
  96                         COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH          = ${DOXYGEN_PATH}"
  97                         COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH          = ${FIG2DEV_PATH}"
  98                         COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
  99                         COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..."
 100                         COMMAND false
 101                         )
 102
 103
 104 endif(DOXYGEN_PATH AND FIG2DEV_PATH)
 105
 106 ##############################################################################"
 107
 108
 109 ADD_CUSTOM_TARGET(ref_guide_pdf
 110     COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
 111     COMMAND make clean
 112     COMMAND make pdf || true
 113     COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
 114     COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
 115     COMMAND make pdf || true
 116     COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
 117     COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
 118
 119     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
 120 )
 121 add_dependencies(pdf ref_guide)