Documentation.cmake 1.49 KB
Newer Older
1 2 3 4 5 6 7 8
#.rst:
# Documentation
# -------------
#
# DocumentationVTK.cmake
#
# This file provides support for the VTK documentation framework.  It
# relies on several tools (Doxygen, Perl, etc).
9

10 11 12 13 14 15 16 17 18 19
#=============================================================================
# Copyright 2001-2009 Kitware, Inc.
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
20
# (To distribute this file outside of CMake, substitute the full
21 22
#  License text for the above reference.)

23 24 25
#
# Build the documentation ?
#
26 27
option(BUILD_DOCUMENTATION "Build the documentation (Doxygen)." OFF)
mark_as_advanced(BUILD_DOCUMENTATION)
28

29
if (BUILD_DOCUMENTATION)
30 31 32 33

  #
  # Check for the tools
  #
34 35 36 37 38 39 40 41
  find_package(UnixCommands)
  find_package(Doxygen)
  find_package(Gnuplot)
  find_package(HTMLHelp)
  find_package(Perl)
  find_package(Wget)

  option(DOCUMENTATION_HTML_HELP
42
    "Build the HTML Help file (CHM)." OFF)
43

44
  option(DOCUMENTATION_HTML_TARZ
45
    "Build a compressed tar archive of the HTML doc." OFF)
46

47
  mark_as_advanced(
48 49
    DOCUMENTATION_HTML_HELP
    DOCUMENTATION_HTML_TARZ
50
    )
51

52
  #
53 54 55 56
  # The documentation process is controled by a batch file.
  # We will probably need bash to create the custom target
  #

57
endif ()