Changeset 26 in pacpusframework

Timestamp:

Jan 8, 2013, 5:00:30 PM (12 years ago)

Author:

sgosseli

Message:

Add the generation of the documentation in the build system.
To build the documentation on Windows:

cmake .. -DPACPUS_INSTALL_DIR=C:\Foo -DPACPUS_BUILD_DOC=TRUE
msbuild doc\documentation.vcxproj
msbuild INSTALL.vcxproj /p:Configuration=Release

Note: doxygen is required, of course.

Location:

trunk

Files:

• CMakeLists.txt (modified) (3 diffs)
• cmake/PacpusConfiguration.cmake (modified) (1 diff)
• cmake/PacpusDependencies.cmake (modified) (1 diff)
• cmake/PacpusInstall.cmake (modified) (1 diff)
• doc (added)
• doc/CMakeLists.txt (added)
• doc/doxyfile.in (added)

trunk/CMakeLists.txt

@@ -26 +26 @@
 set(PACPUS_3RD_PARTY_DIR    ${PACPUS_ROOT_DIR}/3rd)
 set(PACPUS_CMAKE_DIR        ${PACPUS_ROOT_DIR}/cmake)
+set(PACPUS_DOC_DIR          ${PACPUS_ROOT_DIR}/doc)
 set(PACPUS_INCLUDE_DIR      ${PACPUS_ROOT_DIR}/include/Pacpus)
 set(PACPUS_SCRIPTS_DIR      ${PACPUS_ROOT_DIR}/scripts)
@@ -71 +72 @@
 
 # ========================================
+# Build the documentation if enabled
+# ========================================
+if (PACPUS_BUILD_DOC)
+  add_subdirectory(${PACPUS_DOC_DIR})
+endif()
+
+# ========================================
 # Pacpus Installation
 # ========================================
@@ -108 +116 @@
 pacpus_info("    Logging enabled:" ${PACPUS_USE_LOG})
 pacpus_info("    Installation of 3rd party:" ${PACPUS_INSTALL_3RD})
+pacpus_info("    Documentation enabled:" ${PACPUS_BUILD_DOC})
 pacpus_info("")
 if("${CMAKE_CURRENT_SOURCE_DIR}" STREQUAL "${CMAKE_CURRENT_BINARY_DIR}")

trunk/cmake/PacpusConfiguration.cmake

@@ -21 +21 @@
 set(PACPUS_USE_LOG      TRUE  CACHE BOOL "Logging using log4cxx, the library is required")
 set(PACPUS_INSTALL_3RD  FALSE CACHE BOOL "Installation of the 3rd party")
+set(PACPUS_BUILD_DOC    FALSE CACHE BOOL "Whether build the documentation (require Doxygen)")

trunk/cmake/PacpusDependencies.cmake

@@ -45 +45 @@
   endif()
 endif()
+
+# ========================================
+# Doxygen
+# ========================================
+if (PACPUS_BUILD_DOC)
+  find_package(Doxygen)
+  if (NOT DOXYGEN_FOUND)
+    message(FATAL_ERROR "Doxygen is needed to build the documentation. Please install it correctly")
+  endif()
+endif()

trunk/cmake/PacpusInstall.cmake

@@ -39 +39 @@
   )
 endif()
+
+# ========================================
+# Installation of the documentation
+# ========================================
+if (PACPUS_BUILD_DOC)
+  install(
+    DIRECTORY
+      ${CMAKE_BINARY_DIR}/doc/html
+    DESTINATION
+      ${PACPUS_INSTALL_DIR}/doc
+  )
+endif()