Permalink
Browse files

Add doxygen-generated documentation and global options

  • Loading branch information...
mfherbst committed Aug 5, 2017
1 parent ea9b5e9 commit c542b86f804c700680d02ff25c3e7c4fe8f89097
Showing with 2,580 additions and 13 deletions.
  1. +18 −9 CMakeLists.txt
  2. +37 −0 doc/CMakeLists.txt
  3. +2,519 −0 doc/Doxyfile.in
  4. +1 −1 modules/gint
  5. +1 −1 modules/gscf
  6. +1 −1 modules/krims
  7. +1 −1 modules/linalgwrap
  8. +2 −0 update_from_sister_repos.sh
@@ -34,15 +34,8 @@ list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/modules/krims/cmake/mo
include(DebugReleaseBuild)
drb_init()
##########################################################################
# Global options
# Path where cmake wants the modules and config packages:
set(PackageModuleLocation share/cmake)
# setup global options (needs to be done before call to project())
option(MOLSTURM_ENABLE_TESTS "Build molsturm tests" ON)
option(MOLSTURM_ENABLE_EXAMPLES "Build molsturm examples" ON)
# Prefer shared to static libs (cmake does the reverse by default.
# We to set this option *before* calling the first 'project')
option(BUILD_SHARED_LIBS "Build shared libraries instead of static ones" ON)
##########################################################################
@@ -58,6 +51,18 @@ include_directories("${PROJECT_BINARY_DIR}/src")
# enable testing of this project
enable_testing()
##########################################################################
# Global options
# Path where cmake wants the modules and config packages:
set(PackageModuleLocation share/cmake)
# setup global options
include(GlobalOption)
global_option(ENABLE_DOCUMENTATION "Build documentation" OFF )
global_option(ENABLE_EXAMPLES "Build example executables" ON )
global_option(ENABLE_TESTS "Build unit test executables" ON )
##########################################################################
# Setup hard and optional dependencies and find components
@@ -103,6 +108,10 @@ if(MOLSTURM_ENABLE_EXAMPLES)
add_subdirectory(examples)
endif()
if(MOLSTURM_ENABLE_DOCUMENTATION)
add_subdirectory(doc)
endif()
##########################################################################
# Finally install package:
include(cmake/install_package.cmake)
@@ -0,0 +1,37 @@
## ---------------------------------------------------------------------
##
## Copyright (C) 2017 by the molsturm authors
##
## This file is part of molsturm.
##
## molsturm is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published
## by the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## molsturm is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with molsturm. If not, see <http://www.gnu.org/licenses/>.
##
## ---------------------------------------------------------------------
include(Documentation)
# Exclude patterns for the actual Doxyfile generated with configure_file
set(DOXY_EXCLUDE_PATTERNS "")
set(DOXY_LATEX "OFF")
if (DOCUMENTATION_DOXYGEN_LATEX)
set(DOXY_LATEX "ON")
endif()
configure_file("Doxyfile.in" "Doxyfile" @ONLY)
setup_doxygen(doc-molsturm-doxygen "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile"
"${CMAKE_CURRENT_BINARY_DIR}/codedoc"
"share/doc/molsturm")
add_custom_target(doc-molsturm ALL)
add_dependencies(doc-molsturm doc-molsturm-doxygen)
Oops, something went wrong.

0 comments on commit c542b86

Please sign in to comment.