kernel/doc/CMakeLists.txt

   1
   2
   3 #-----------------------------------------------------------------------------
   4 OPTION(BUILD_bbtk_DOC "Build documentation for bbtk." OFF)
   5 SWITCH_ON_IF_BUILD_ALL(BUILD_bbtk_DOC)
   6 #-----------------------------------------------------------------------------
   7
   8
   9 #-----------------------------------------------------------------------------
  10 IF(BUILD_bbtk_DOC)
  11
  12   OPTION(BUILD_bbtk_DOC_PACKAGE
  13     "Build bbtk packages documentation (bbi+dot)."       ON)
  14   OPTION(BUILD_bbtk_DOC_DOXYGEN
  15     "Build doxygen documentation (doxygen)."             ON)
  16   OPTION(BUILD_bbtk_DOC_GUIDES_PDF
  17     "Build bbtk Guides', PDF format (latex)."    ON)
  18   OPTION(BUILD_bbtk_DOC_GUIDES_HTML
  19     "Build bbtk Guides', HTML format (latex+tth)."       ON)
  20
  21 ELSE(BUILD_bbtk_DOC)
  22
  23   IF(BUILD_bbtk_DOC_PACKAGE)
  24     SET(BUILD_bbtk_DOC_PACKAGE OFF CACHE BOOL
  25       "Build bbtk packages documentation (bbdoc+dot)."  FORCE)
  26   ENDIF(BUILD_bbtk_DOC_PACKAGE)
  27   IF(BUILD_bbtk_DOC_DOXYGEN)
  28     SET(BUILD_bbtk_DOC_DOXYGEN OFF CACHE BOOL
  29       "Build doxygen documentation. (doxygen)"          FORCE)
  30   ENDIF(BUILD_bbtk_DOC_DOXYGEN)
  31
  32   IF(BUILD_bbtk_DOC_GUIDES_PDF)
  33     SET(BUILD_bbtk_DOC_GUIDES_PDF OFF CACHE BOOL
  34       "Build bbtk Guides', PDF format (latex)." FORCE)
  35   ENDIF(BUILD_bbtk_DOC_GUIDES_PDF)
  36
  37   IF(BUILD_bbtk_DOC_GUIDES_HTML)
  38     SET(BUILD_bbtk_DOC_GUIDES_HTML OFF CACHE BOOL
  39       "Build bbtk Guides', HTML format (latex tth)."            FORCE)
  40   ENDIF(BUILD_bbtk_DOC_GUIDES_HTML)
  41 #  IF(BUILD_bbtk_DOC_SCRIPTS)
  42 #    SET(BUILD_bbtk_DOC_SCRIPTS_HTML OFF CACHE BOOL
  43 #      "Build bbtk scripts documentation (bbi+dot)."            FORCE)
  44 #  ENDIF(BUILD_bbtk_DOC_SCRIPTS)
  45
  46 ENDIF(BUILD_bbtk_DOC)
  47
  48
  49 #-----------------------------------------------------------------------------
  50 IF(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_DOXYGEN)
  51   INCLUDE(../cmake/BBTKBuildDoxygenDoc.cmake)
  52   SUBDIRS(bbtkDoxygen)
  53 ENDIF(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_DOXYGEN)
  54 #-----------------------------------------------------------------------------
  55
  56
  57 #-----------------------------------------------------------------------------
  58 IF(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_GUIDES_PDF)
  59   INCLUDE(../cmake/BBTKBuildLatexDoc.cmake)
  60 ELSE(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_GUIDES_HTML)
  61   MACRO(BBTK_BUILD_LATEX_DOC TEX_FILE)
  62   ENDMACRO(BBTK_BUILD_LATEX_DOC)
  63 ENDIF(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_GUIDES_PDF)
  64 #-----------------------------------------------------------------------------
  65
  66
  67 #-----------------------------------------------------------------------------
  68 IF(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_GUIDES_HTML)
  69   INCLUDE(../cmake/BBTKBuildHtmlDocFromLatex.cmake)
  70 ELSE(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_GUIDES_HTML)
  71   MACRO(BBTK_BUILD_HTML_DOC_FROM_LATEX SOURCE)
  72   ENDMACRO(BBTK_BUILD_HTML_DOC_FROM_LATEX)
  73 ENDIF(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_GUIDES_HTML)
  74 ENDIF(BUILD_bbtk_DOC_GUIDES_PDF)
  75 #-----------------------------------------------------------------------------
  76
  77
  78 #-----------------------------------------------------------------------------
  79 IF(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_GUIDES_PDF OR BUILD_bbtk_DOC_GUIDES_HTML)
  80   SUBDIRS(bbtkUsersGuide)
  81   SUBDIRS(bbtkPackageDevelopersGuide)
  82   SUBDIRS(bbtkDevelopersGuide)
  83 ENDIF(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_GUIDES_PDF OR BUILD_bbtk_DOC_GUIDES_HTML)
  84 #-----------------------------------------------------------------------------
  85
  86
  87 #-----------------------------------------------------------------------------
  88 # Web site
  89 IF(BUILD_bbtk_DOC)
  90   # Configure main page index.html for build tree
  91   CONFIGURE_FILE(
  92     index.html.in
  93     ${BBTK_DOC_BUILD_PATH}/index.html
  94     @ONLY
  95     )
  96   # Install it
  97   INSTALL(
  98     FILES ${BBTK_DOC_BUILD_PATH}/index.html
  99     DESTINATION ${BBTK_DOC_INSTALL_PATH}
 100     )
 101   # Configure main page index-no-frame.html for build tree
 102    CONFIGURE_FILE(
 103     index-no-frame.html.in
 104     ${BBTK_DOC_BUILD_PATH}/index-no-frame.html
 105     @ONLY
 106     )
 107   # Install it
 108   INSTALL(
 109     FILES ${BBTK_DOC_BUILD_PATH}/index-no-frame.html
 110     DESTINATION ${BBTK_DOC_INSTALL_PATH}
 111     )
 112
 113   # Recurse it bbtkWebSite dir
 114   SUBDIRS(bbtkWebSite)
 115
 116
 117
 118 ENDIF(BUILD_bbtk_DOC)
 119 #-----------------------------------------------------------------------------
 120