Modules/Documentation.cmake

   1 # - DocumentationVTK.cmake
   2 # This file provides support for the VTK documentation framework.
   3 # It relies on several tools (Doxygen, Perl, etc).
   4
   5 #=============================================================================
   6 # Copyright 2001-2009 Kitware, Inc.
   7 #
   8 # Distributed under the OSI-approved BSD License (the "License");
   9 # see accompanying file Copyright.txt for details.
  10 #
  11 # This software is distributed WITHOUT ANY WARRANTY; without even the
  12 # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  13 # See the License for more information.
  14 #=============================================================================
  15 # (To distribute this file outside of CMake, substitute the full
  16 #  License text for the above reference.)
  17
  18 #
  19 # Build the documentation ?
  20 #
  21 OPTION(BUILD_DOCUMENTATION "Build the documentation (Doxygen)." OFF)
  22 MARK_AS_ADVANCED(BUILD_DOCUMENTATION)
  23
  24 IF (BUILD_DOCUMENTATION)
  25
  26   #
  27   # Check for the tools
  28   #
  29   FIND_PACKAGE(UnixCommands)
  30   FIND_PACKAGE(Doxygen)
  31   FIND_PACKAGE(Gnuplot)
  32   FIND_PACKAGE(HTMLHelp)
  33   FIND_PACKAGE(Perl)
  34   FIND_PACKAGE(Wget)
  35
  36   OPTION(DOCUMENTATION_HTML_HELP
  37     "Build the HTML Help file (CHM)." OFF)
  38
  39   OPTION(DOCUMENTATION_HTML_TARZ
  40     "Build a compressed tar archive of the HTML doc." OFF)
  41
  42   MARK_AS_ADVANCED(
  43     DOCUMENTATION_HTML_HELP
  44     DOCUMENTATION_HTML_TARZ
  45     )
  46
  47   #
  48   # The documentation process is controled by a batch file.
  49   # We will probably need bash to create the custom target
  50   #
  51
  52 ENDIF (BUILD_DOCUMENTATION)