kernel/doc/CMakeLists.txt

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