Modules/Documentation.cmake

   1 # DocumentationVTK.cmake
   2 #
   3 # This file provides support for the VTK documentation framework.
   4 # It relies on several tools (Doxygen, Perl, etc).
   5
   6 #
   7 # Build the documentation ?
   8 #
   9 OPTION(BUILD_DOCUMENTATION "Build the documentation (Doxygen)." OFF)
  10 MARK_AS_ADVANCED(BUILD_DOCUMENTATION)
  11
  12 IF (BUILD_DOCUMENTATION)
  13
  14   #
  15   # Check for the tools
  16   #
  17   INCLUDE(${CMAKE_ROOT}/Modules/FindUnixCommands.cmake)
  18   INCLUDE(${CMAKE_ROOT}/Modules/FindDoxygen.cmake)
  19   INCLUDE(${CMAKE_ROOT}/Modules/FindGnuplot.cmake)
  20   INCLUDE(${CMAKE_ROOT}/Modules/FindHhc.cmake)
  21   INCLUDE(${CMAKE_ROOT}/Modules/FindPerl.cmake)
  22   INCLUDE(${CMAKE_ROOT}/Modules/FindWget.cmake)
  23
  24   OPTION(DOCUMENTATION_HTML_HELP
  25          "Build the HTML Help file (CHM)." OFF)
  26
  27   OPTION(DOCUMENTATION_HTML_TARZ
  28          "Build a compressed tar archive of the HTML doc." OFF)
  29
  30   MARK_AS_ADVANCED(
  31     DOCUMENTATION_HTML_HELP
  32     DOCUMENTATION_HTML_TARZ
  33   )
  34
  35   #
  36   # The documentation process is controled by a batch file.
  37   # We will probably need bash to create the custom target
  38   #
  39
  40 ENDIF (BUILD_DOCUMENTATION)