GenerateDoc.cmake

   1 #### Generate the html documentation
   2
   3 if(BIBTEX2HTML)
   4         set(BIBTEX2HTML_PATH ${BIBTEX2HTML})
   5 else(BIBTEX2HTML)
   6         find_path(BIBTEX2HTML_PATH      NAMES bibtex2html       PATHS NO_DEFAULT_PATHS)
   7 endif(BIBTEX2HTML)
   8
   9 find_path(FIG2DEV_PATH  NAMES fig2dev   PATHS NO_DEFAULT_PATHS)
  10 find_path(DOXYGEN_PATH  NAMES doxygen   PATHS NO_DEFAULT_PATHS)
  11
  12 ### Check whether the bibtex2html that we found is the one that Arnaud requires
  13 exec_program("${BIBTEX2HTML_PATH}/bibtex2html -version" OUTPUT_VARIABLE OUTPUT_BIBTEX2HTML_VERSION)
  14 STRING(REPLACE "[-bibtex]" "" OUTPUT_BIBTEX2HTML_VERSION_2 ${OUTPUT_BIBTEX2HTML_VERSION})
  15
  16 if(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # wrong version
  17         SET(GOOD_BIBTEX2HTML_VERSION 0)
  18 else(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # good version
  19         SET(GOOD_BIBTEX2HTML_VERSION 1)
  20 endif(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION})
  21
  22 if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION)
  23
  24         configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
  25         configure_file(${CMAKE_HOME_DIRECTORY}/doc/footer.html.in ${CMAKE_HOME_DIRECTORY}/doc/footer.html @ONLY)
  26
  27         ADD_CUSTOM_TARGET(documentation
  28                 COMMENT "Generating the SimGrid documentation..."
  29                 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
  30             COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_HOME_DIRECTORY}/doc/html
  31                 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  32         )
  33
  34         ADD_CUSTOM_COMMAND(TARGET documentation
  35             COMMAND ${CMAKE_COMMAND} -E echo "XX Doxygen pass"
  36                 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
  37
  38         COMMAND ${CMAKE_COMMAND} -E echo "XX Javadoc pass"
  39         COMMAND javadoc -d ${CMAKE_HOME_DIRECTORY}/doc/html/javadoc/ ${CMAKE_HOME_DIRECTORY}/org/simgrid/msg/*.java
  40
  41                 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/
  42         )
  43
  44 else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION)
  45
  46         ADD_CUSTOM_TARGET(documentation
  47                         COMMENT "Generating the SimGrid documentation..."
  48                         )
  49
  50         if(NOT GOOD_BIBTEX2HTML_VERSION) # wrong version
  51                 ADD_CUSTOM_COMMAND(TARGET documentation
  52                         COMMAND ${CMAKE_COMMAND} -E echo "This is not the good bibtex2html program !!!"
  53                         COMMAND ${CMAKE_COMMAND} -E echo  "You can download it from:"
  54                         COMMAND ${CMAKE_COMMAND} -E echo  "  ftp://ftp-sop.inria.fr/epidaure/Softs/bibtex2html/bibtex2html-1.02.tar.gz"
  55                         COMMAND ${CMAKE_COMMAND} -E echo  "There is also an unofficial Debian/Ubuntu package, see:"
  56                         COMMAND ${CMAKE_COMMAND} -E echo  "  http://www.loria.fr/~lnussbau/bibtex2html/README"
  57                         )
  58         endif(NOT GOOD_BIBTEX2HTML_VERSION)
  59
  60         ADD_CUSTOM_COMMAND(TARGET documentation
  61                         COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH          = ${DOXYGEN_PATH}"
  62                         COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH          = ${FIG2DEV_PATH}"
  63                         COMMAND ${CMAKE_COMMAND} -E echo "BIBTEX2HTML_PATH      = ${BIBTEX2HTML_PATH}"
  64                         COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
  65                         COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..."
  66                         COMMAND false
  67                         )
  68
  69
  70 endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION)