]> Creatis software - bbtk.git/blobdiff - kernel/doc/CMakeLists.txt
#2560 BBTK Feature New Normal - bbstd package : WriteColumnsString
[bbtk.git] / kernel / doc / CMakeLists.txt
index 630b9a2232f711be422bb0938874607badc72c7d..84a6d6f67252d8da4b3fb49bdc1a9013c8e423fe 100755 (executable)
@@ -1,92 +1,71 @@
+ # ---------------------------------------------------------------------
+ #
+ # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
+ #                        pour la SantÈ)
+ # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+ # Previous Authors : Laurent Guigues, Jean-Pierre Roux
+ # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
+ #
+ #  This software is governed by the CeCILL-B license under French law and
+ #  abiding by the rules of distribution of free software. You can  use,
+ #  modify and/ or redistribute the software under the terms of the CeCILL-B
+ #  license as circulated by CEA, CNRS and INRIA at the following URL
+ #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
+ #  or in the file LICENSE.txt.
+ #
+ #  As a counterpart to the access to the source code and  rights to copy,
+ #  modify and redistribute granted by the license, users are provided only
+ #  with a limited warranty  and the software's author,  the holder of the
+ #  economic rights,  and the successive licensors  have only  limited
+ #  liability.
+ #
+ #  The fact that you are presently reading this means that you have had
+ #  knowledge of the CeCILL-B license and that you accept its terms.
+ # ------------------------------------------------------------------------ */
 
 
-#-----------------------------------------------------------------------------
-OPTION(BUILD_bbtk_DOC "Build documentation for bbtk." OFF)
-SWITCH_ON_IF_BUILD_ALL(BUILD_bbtk_DOC)
-#-----------------------------------------------------------------------------
-
-
-#-----------------------------------------------------------------------------
-IF(BUILD_bbtk_DOC)
-  
-  OPTION(BUILD_bbtk_DOC_PACKAGE 
-    "Build bbtk packages documentation (bbi+dot)."      ON)
-  OPTION(BUILD_bbtk_DOC_DOXYGEN 
-    "Build doxygen documentation (doxygen)."            ON)
-  OPTION(BUILD_bbtk_DOC_GUIDES_PDF 
-    "Build bbtk Guides', PDF format (latex)."   ON)
-  OPTION(BUILD_bbtk_DOC_GUIDES_HTML 
-    "Build bbtk Guides', HTML format (latex+tth)."      ON)
-
-ELSE(BUILD_bbtk_DOC)
-  
-  IF(BUILD_bbtk_DOC_PACKAGE)
-    SET(BUILD_bbtk_DOC_PACKAGE OFF CACHE BOOL 
-      "Build bbtk packages documentation (bbdoc+dot)." FORCE)
-  ENDIF(BUILD_bbtk_DOC_PACKAGE)
-  IF(BUILD_bbtk_DOC_DOXYGEN)
-    SET(BUILD_bbtk_DOC_DOXYGEN OFF CACHE BOOL 
-      "Build doxygen documentation. (doxygen)"         FORCE)
-  ENDIF(BUILD_bbtk_DOC_DOXYGEN)
-  
-  IF(BUILD_bbtk_DOC_GUIDES_PDF)
-    SET(BUILD_bbtk_DOC_GUIDES_PDF OFF CACHE BOOL 
-      "Build bbtk Guides', PDF format (latex)."        FORCE)
-  ENDIF(BUILD_bbtk_DOC_GUIDES_PDF)
-  
-  IF(BUILD_bbtk_DOC_GUIDES_HTML)
-    SET(BUILD_bbtk_DOC_GUIDES_HTML OFF CACHE BOOL 
-      "Build bbtk Guides', HTML format (latex tth)."           FORCE)
-  ENDIF(BUILD_bbtk_DOC_GUIDES_HTML)
-#  IF(BUILD_bbtk_DOC_SCRIPTS)
-#    SET(BUILD_bbtk_DOC_SCRIPTS_HTML OFF CACHE BOOL 
-#      "Build bbtk scripts documentation (bbi+dot)."           FORCE)
-#  ENDIF(BUILD_bbtk_DOC_SCRIPTS)
-  
-ENDIF(BUILD_bbtk_DOC)
 
 
 #-----------------------------------------------------------------------------
-IF(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_DOXYGEN)
+IF(BUILD_BBTK_DOC AND BUILD_BBTK_DOC_DOXYGEN)
   INCLUDE(../cmake/BBTKBuildDoxygenDoc.cmake)
-  SUBDIRS(bbtkDoxygen)
-ENDIF(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_DOXYGEN)
+  ADD_SUBDIRECTORY(bbtkDoxygen)
+ENDIF(BUILD_BBTK_DOC AND BUILD_BBTK_DOC_DOXYGEN)
 #-----------------------------------------------------------------------------
 
 
 #-----------------------------------------------------------------------------
-IF(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_GUIDES_PDF)
+IF(BUILD_BBTK_DOC AND BUILD_BBTK_DOC_GUIDES_PDF)
   INCLUDE(../cmake/BBTKBuildLatexDoc.cmake)
-ELSE(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_GUIDES_HTML)
+ELSE(BUILD_BBTK_DOC AND BUILD_BBTK_DOC_GUIDES_HTML)
   MACRO(BBTK_BUILD_LATEX_DOC TEX_FILE)
   ENDMACRO(BBTK_BUILD_LATEX_DOC)
-ENDIF(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_GUIDES_PDF)
+ENDIF(BUILD_BBTK_DOC AND BUILD_BBTK_DOC_GUIDES_PDF)
 #-----------------------------------------------------------------------------
 
 
 #-----------------------------------------------------------------------------
-IF(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_GUIDES_HTML)
+IF(BUILD_BBTK_DOC AND BUILD_BBTK_DOC_GUIDES_HTML)
   INCLUDE(../cmake/BBTKBuildHtmlDocFromLatex.cmake)
-ELSE(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_GUIDES_HTML)
+ELSE(BUILD_BBTK_DOC AND BUILD_BBTK_DOC_GUIDES_HTML)
   MACRO(BBTK_BUILD_HTML_DOC_FROM_LATEX SOURCE)
   ENDMACRO(BBTK_BUILD_HTML_DOC_FROM_LATEX)
-ENDIF(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_GUIDES_HTML)
-ENDIF(BUILD_bbtk_DOC_GUIDES_PDF)
+ENDIF(BUILD_BBTK_DOC AND BUILD_BBTK_DOC_GUIDES_HTML)
 #-----------------------------------------------------------------------------
 
 
 #-----------------------------------------------------------------------------
-IF(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_GUIDES_PDF OR BUILD_bbtk_DOC_GUIDES_HTML)
-  SUBDIRS(bbtkUsersGuide)
-  SUBDIRS(bbtkPackageDevelopersGuide)
-  SUBDIRS(bbtkDevelopersGuide)
-ENDIF(BUILD_bbtk_DOC AND BUILD_bbtk_DOC_GUIDES_PDF OR BUILD_bbtk_DOC_GUIDES_HTML)
+IF(BUILD_BBTK_DOC AND BUILD_BBTK_DOC_GUIDES_PDF OR BUILD_BBTK_DOC_GUIDES_HTML)
+  ADD_SUBDIRECTORY(bbtkUsersGuide)
+  ADD_SUBDIRECTORY(bbtkPackageDevelopersGuide)
+  ADD_SUBDIRECTORY(bbtkDevelopersGuide)
+ENDIF(BUILD_BBTK_DOC AND BUILD_BBTK_DOC_GUIDES_PDF OR BUILD_BBTK_DOC_GUIDES_HTML)
 #-----------------------------------------------------------------------------
 
 
 #-----------------------------------------------------------------------------
 # Web site 
-IF(BUILD_bbtk_DOC)
+IF(BUILD_BBTK_DOC)
   # Configure main page index.html for build tree
   CONFIGURE_FILE(
     index.html.in
@@ -109,22 +88,23 @@ IF(BUILD_bbtk_DOC)
     FILES ${BBTK_DOC_BUILD_PATH}/index-no-frame.html 
     DESTINATION ${BBTK_DOC_INSTALL_PATH}
     ) 
+  # Configure help_contents.html for build tree
+   CONFIGURE_FILE(
+    help_contents.html.in
+    ${BBTK_DOC_BUILD_PATH}/help_contents.html
+    @ONLY
+    )
+  # Install it 
+  INSTALL( 
+    FILES ${BBTK_DOC_BUILD_PATH}/help_contents.html
+    DESTINATION ${BBTK_DOC_INSTALL_PATH}
+    ) 
 
   # Recurse it bbtkWebSite dir
-  SUBDIRS(bbtkWebSite)
+  ADD_SUBDIRECTORY(bbtkWebSite)
 
 
-  INSTALL(
-    DIRECTORY  ${BBTK_BINARY_DIR}/${BBTK_DOC_REL_PATH}
-    DESTINATION  ${BBTK_SHARE_REL_PATH}
-    )
-
-  INSTALL(
-    DIRECTORY  ${BBTK_BINARY_DIR}/${BBTK_BBS_REL_PATH}
-    DESTINATION  ${BBTK_SHARE_REL_PATH}
-    )
-  
 
-ENDIF(BUILD_bbtk_DOC)
+ENDIF(BUILD_BBTK_DOC)
 #-----------------------------------------------------------------------------