updated doc generation/install

Author: sy-c

CMakeLists.txt

@@ -10,20 +10,18 @@ cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION})
 project(
   InfoLogger
   DESCRIPTION "O2 Logging library and services"
-  LANGUAGES CXX C
+  LANGUAGES NONE
 )
 
-# default install dirs	
-include(GNUInstallDirs)
-
-# add subdirectories
-add_subdirectory(doc)
-# stop immediately for easy building of doc only
+# simplified build mode for doc only
 if(ONLYDOC)
+  add_subdirectory(doc)
   return()
 endif()
 
 # global compilation options
+enable_language(C)
+enable_language(CXX)
 set(CMAKE_CXX_STANDARD 14)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
@@ -33,11 +31,15 @@ set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 # build-time binaries
 set(EXECUTABLE_OUTPUT_PATH "${CMAKE_BINARY_DIR}/bin")
 # installation
+include(GNUInstallDirs)
 set(CMAKE_INSTALL_LIBDIR lib)
 
 # add local modules directory
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")
 
+# add subdirectories
+add_subdirectory(doc)
+
 # dependencies to build the InfoLogger components
 # NB: cmake/InfoLoggerConfig.cmake defines dependencies for clients using the library
 #find_package(Common REQUIRED)

doc/CMakeLists.txt

@@ -1,17 +1,20 @@
-include(FindDoxygen)
+# Generate documentation
+
+# define doc build path
+set(DOC_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/doc-build")
 
-# put doc in a subdirectory with project name, if not already set so
+# define doc installation path
+# ensures it ends with project name
 if (NOT CMAKE_INSTALL_DOCDIR)
   set(CMAKE_INSTALL_DOCDIR "doc")
 endif()
 if (NOT "${CMAKE_INSTALL_DOCDIR}" MATCHES "${PROJECT_NAME}$")
   set(CMAKE_INSTALL_DOCDIR "${CMAKE_INSTALL_DOCDIR}/${PROJECT_NAME}")
 endif()
-set(DOC_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_DOCDIR}")
 
 # log doc build(install paths)
-message(STATUS "Documentation will be generated in ${DOC_OUTPUT_DIR}")
-message(STATUS "Documentation will be installed in ${CMAKE_INSTALL_DOCDIR}")
+message(STATUS "Documentation will be built in ${DOC_BUILD_DIR}")
+message(STATUS "Documentation will be installed in ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_DOCDIR}")
 
 # general files directly from source
 install(
@@ -21,6 +24,7 @@ install(
 )
 
 # doxygen-generated files
+include(FindDoxygen)
 if (DOXYGEN_FOUND)
   if(NOT DOXYGEN_DOT_FOUND)
     message(WARNING "dot not found. Please install Graphviz.")
@@ -42,19 +46,19 @@ if (DOXYGEN_FOUND)
   # doxygen fails creating multi-level output directory, make sure it exists
   add_custom_target(
     doc-dir
-    COMMAND ${CMAKE_COMMAND} -E make_directory "${DOC_OUTPUT_DIR}"
+    COMMAND ${CMAKE_COMMAND} -E make_directory "${DOC_BUILD_DIR}"
     WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
     COMMENT "Create the doxygen output directory"
     VERBATIM
   )
 
   # install generated files
   install(
-    DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_INSTALL_DOCDIR}/html
+    DIRECTORY ${DOC_BUILD_DIR}/html
     TYPE DOC
     OPTIONAL # because available only after "make doc"
   )
-else (DO)
+else ()
   message(WARNING "Doxygen not found")
 endif (DOXYGEN_FOUND)
 

doc/doxyfile.in

@@ -58,7 +58,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = "@DOC_OUTPUT_DIR@"
+OUTPUT_DIRECTORY       = "@DOC_BUILD_DIR@"
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and