buildtools/Cmake/GenerateDoc.cmake

   1 #### Generate the whole html documentation
   2
   3 find_path(DOXYGEN_PATH  NAMES doxygen  PATHS NO_DEFAULT_PATHS)
   4 find_path(FIG2DEV_PATH  NAMES fig2dev  PATHS NO_DEFAULT_PATHS)
   5
   6 if(DOXYGEN_PATH)
   7
   8   execute_process(COMMAND ${DOXYGEN_PATH}/doxygen --version OUTPUT_VARIABLE DOXYGEN_VERSION )
   9   string(REGEX MATCH "^[0-9]" DOXYGEN_MAJOR_VERSION "${DOXYGEN_VERSION}")
  10   string(REGEX MATCH "^[0-9].[0-9]" DOXYGEN_MINOR_VERSION "${DOXYGEN_VERSION}")
  11   string(REGEX MATCH "^[0-9].[0-9].[0-9]" DOXYGEN_PATCH_VERSION "${DOXYGEN_VERSION}")
  12   string(REGEX REPLACE "^${DOXYGEN_MINOR_VERSION}." "" DOXYGEN_PATCH_VERSION "${DOXYGEN_PATCH_VERSION}")
  13   string(REGEX REPLACE "^${DOXYGEN_MAJOR_VERSION}." "" DOXYGEN_MINOR_VERSION "${DOXYGEN_MINOR_VERSION}")
  14   message(STATUS "Doxygen version : ${DOXYGEN_MAJOR_VERSION}.${DOXYGEN_MINOR_VERSION}.${DOXYGEN_PATCH_VERSION}")
  15
  16   include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateUserGuide.cmake)
  17   include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateRefGuide.cmake)
  18   include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateDevGuide.cmake)
  19
  20   set(DOC_PNGS
  21     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
  22     ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png
  23     )
  24
  25   configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
  26
  27   ADD_CUSTOM_TARGET(simgrid_documentation
  28     COMMENT "Generating the SimGrid documentation..."
  29     DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
  30     COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
  31     COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_HOME_DIRECTORY}/doc/html
  32     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  33     )
  34
  35   foreach(file ${DOC_PNGS})
  36     ADD_CUSTOM_COMMAND(
  37       TARGET simgrid_documentation
  38       COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
  39       )
  40   endforeach(file ${DOC_PNGS})
  41
  42   ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  43     COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/
  44     )
  45
  46   ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
  47     COMMAND ${CMAKE_COMMAND} -E echo "XX Doxygen pass"
  48     COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
  49     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
  50     )
  51
  52   ADD_CUSTOM_TARGET(pdf
  53     COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf"
  54     COMMAND make clean
  55     COMMAND make pdf || true
  56     COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf"
  57     COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf
  58     COMMAND make pdf || true
  59     COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf"
  60     COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf
  61     WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/
  62     )
  63   add_dependencies(pdf simgrid_documentation)
  64
  65   ADD_CUSTOM_TARGET(error_doxygen
  66     COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation"
  67     COMMAND false
  68     )
  69
  70   if(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
  71     add_dependencies(simgrid_documentation error_doxygen)
  72   else()
  73     add_dependencies(simgrid_documentation ref_guide)
  74     add_dependencies(simgrid_documentation user_guide)
  75     add_dependencies(simgrid_documentation dev_guide)
  76   endif()
  77
  78 endif()
  79
  80 #############################################
  81 ### Fill in the "make sync-gforge" target ###
  82 #############################################
  83
  84 ### TODO: LBO: CHECK IF CORRECT
  85 add_custom_target(sync-gforge-doc
  86   COMMAND chmod g+rw -R doc/
  87   COMMAND chmod a+rX -R doc/
  88   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ || true
  89   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/ || true
  90   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/ || true
  91   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/dev_guide/ || true
  92   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true
  93   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html/ || true
  94   COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/dev_guide/html/ || true
  95
  96   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
  97   doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true
  98
  99   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
 100   doc/user_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true
 101
 102   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
 103   doc/ref_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html || true
 104
 105   COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times
 106   doc/dev_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/dev_guide/html || true
 107
 108   COMMAND scp doc/user_guide/html/simgrid_modules2.png doc/user_guide/html/simgrid_modules.png doc/webcruft/simgrid_logo_2011.png
 109   doc/webcruft/simgrid_logo_2011_small.png scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/
 110   WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
 111   )
 112 add_dependencies(sync-gforge-doc simgrid_documentation)
 113
 114 add_custom_target(sync-gforge-dtd
 115   COMMAND scp src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/simgrid.dtd
 116   COMMAND scp src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid.dtd
 117   WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}"
 118   )
 119
 120 ##############################################################################"
 121 # GTUT FILES
 122
 123 #message(STATUS "Check individual TOCs")
 124
 125 #foreach(file_name ${LISTE_GTUT})
 126 #   file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc)
 127 #   file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc)
 128 #
 129 #   file(READ "${file_name}" file_content)
 130 #   string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
 131 #   string(REPLACE "\n" ";" valeur_line "${valeur_line}")
 132 #   string(REPLACE "\n" ";" file_content "${file_content}")
 133 #
 134 #   file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc "\n") # make sure it exists
 135 #   foreach(line ${file_content})
 136 #       string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
 137 #       string(REGEX MATCH ".*_toc.*" line3 "${line}")
 138 #       if(line2 AND NOT line3)
 139 #           string(REPLACE "\\section " "" line2 ${line2})
 140 #           string(REPLACE "\\subsection " "subsection" line2 ${line2})
 141 #           string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2})
 142 #           string(REGEX REPLACE " .*" "" line2 ${line2})
 143 #           set(line2                               " - \\ref ${line2}")
 144 #           string(REPLACE " - \\ref subsection"    "   - \\ref " line2 ${line2})
 145 #           string(REPLACE " - \\ref subsubsection" "     - \\ref " line2 ${line2})
 146 #           file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc "${line2}\n")
 147 #       endif()
 148 #   endforeach(line ${file_content})
 149 #
 150 #   file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc "\n") # make sure it exists
 151 #   foreach(line ${valeur_line})
 152 #       string(REGEX MATCH ".*ref.*" line_ok ${line})
 153 #       if(line_ok)
 154 #           file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc "${line_ok}\n")
 155 #       endif()
 156 #   endforeach(line ${valeur_line})
 157 #
 158 #   exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc" OUTPUT_VARIABLE compare_files)
 159 #   if(compare_files)
 160 #       message(STATUS "Wrong toc for ${file_name}. Should be:")
 161 #       file(READ "${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc" file_content)
 162 #       message("${file_content}")
 163 #       exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc")
 164 #        endif()
 165 #endforeach(file_name ${LISTE_GTUT})
 166 #
 167 #file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc)
 168 #file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc)
 169 #
 170 #message(STATUS "Check main TOC")
 171 #
 172 #foreach(file_name ${LISTE_GTUT})
 173 #   file(READ "${file_name}" file_content)
 174 #   string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
 175 #   string(REPLACE "\n" ";" valeur_line "${valeur_line}")
 176 #   string(REPLACE "\n" ";" file_content "${file_content}")
 177 #
 178 #   foreach(line ${file_content})
 179 #       string(REGEX MATCH ".*@page.*" line2 "${line}")
 180 #       if(line2)
 181 #           string(REPLACE "@page " "" line2 "${line2}")
 182 #           string(REGEX REPLACE " .*" "" line2 "${line2}")
 183 #           set(line2 " - \\ref ${line2}")
 184 #           file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc "${line2}\n")
 185 #       endif()
 186 #   endforeach(line ${file_content})
 187 #
 188 #   foreach(line ${valeur_line})
 189 #       string(REGEX MATCH ".*toc.*" line1 "${line}")
 190 #       string(REGEX MATCH ".*<hr>.*" line2 "${line}")
 191 #       string(REGEX MATCH "^[ ]*$" line3 "${line}")
 192 #       string(REGEX MATCH "Table of Contents" line4 "${line}")
 193 #       if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
 194 #           file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc "   ${line}\n")
 195 #       endif()
 196 #   endforeach(line ${valeur_line})
 197 #endforeach(file_name ${LISTE_GTUT})
 198 #
 199 #file(READ "${CMAKE_HOME_DIRECTORY}/doc/doxygen/gtut-tour.doc" file_content)
 200 #string(REPLACE "\n" ";" file_content "${file_content}")
 201 #foreach(line ${file_content})
 202 #   string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}")
 203 #   if(line1)
 204 #       file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc "${line}\n")
 205 #   endif()
 206 #endforeach(line ${file_content})
 207 #
 208 #exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc" OUTPUT_VARIABLE compare_files)
 209 #if(compare_files)
 210 #   message(STATUS "Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
 211 #   exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc")
 212 #else()
 213 #   file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc)
 214 #endif()
 215 #
 216 #file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc)