2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 2012,2013,2014, by the GROMACS development team, led by
5 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 # and including many others, as listed in the AUTHORS file in the
7 # top-level source directory and at http://www.gromacs.org.
9 # GROMACS is free software; you can redistribute it and/or
10 # modify it under the terms of the GNU Lesser General Public License
11 # as published by the Free Software Foundation; either version 2.1
12 # of the License, or (at your option) any later version.
14 # GROMACS is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 # Lesser General Public License for more details.
19 # You should have received a copy of the GNU Lesser General Public
20 # License along with GROMACS; if not, see
21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 # If you want to redistribute modifications to GROMACS, please
25 # consider that scientific software is very special. Version
26 # control is crucial - bugs must be traceable. We will be happy to
27 # consider code for inclusion in the official distribution, but
28 # derived work must not be called official GROMACS. Details are found
29 # in the README & COPYING files - if they are missing, get the
30 # official version at http://www.gromacs.org.
32 # To help us fund GROMACS development, we humbly ask that you cite
33 # the research papers on the package. Check out http://www.gromacs.org.
35 include(gmxOptionUtilities)
37 find_package(Doxygen QUIET)
39 # This logic closely follows that found in FindDoxygen.cmake for dot,
40 # except that the PATH variable is not cached.
41 FIND_PROGRAM(DOXYGEN_MSCGEN_EXECUTABLE
43 DOC "Message sequence chart renderer tool (http://www.mcternan.me.uk/mscgen/)")
44 if (DOXYGEN_MSCGEN_EXECUTABLE)
45 set(DOXYGEN_MSCGEN_FOUND TRUE)
46 get_filename_component(DOXYGEN_MSCGEN_PATH "${DOXYGEN_MSCGEN_EXECUTABLE}" PATH)
48 mark_as_advanced(DOXYGEN_MSCGEN_EXECUTABLE)
53 "Skip parts of Doxygen documentation (in particular, many graphs) to save disk space and time"
56 mark_as_advanced(GMX_COMPACT_DOXYGEN)
58 find_package(PythonInterp)
59 set(USE_PYTHON_SCRIPTS OFF)
60 if (PYTHONINTERP_FOUND AND NOT PYTHON_VERSION_STRING VERSION_LESS "2.6")
61 set(USE_PYTHON_SCRIPTS ON)
64 add_custom_target(find-installed-headers
65 COMMAND ${CMAKE_COMMAND}
66 -D SRCDIR=${CMAKE_SOURCE_DIR}
67 -D BUILDDIR=${CMAKE_BINARY_DIR}
68 -D OUTFILE=${CMAKE_CURRENT_BINARY_DIR}/installed-headers.txt
69 -P ${CMAKE_CURRENT_SOURCE_DIR}/getInstalledHeaders.cmake
70 COMMENT "Generating installed headers list" VERBATIM)
72 ########################################################################
73 # Doxygen configuration
74 ########################################################################
76 FILE(GLOB NB_KERNEL_DIRS
77 ${CMAKE_SOURCE_DIR}/src/gromacs/gmxlib/nonbonded/nb_kernel_*/)
78 LIST(REMOVE_ITEM NB_KERNEL_DIRS
79 ${CMAKE_SOURCE_DIR}/src/gromacs/gmxlib/nonbonded/nb_kernel_c)
80 FOREACH(NB_KERNEL_DIR ${NB_KERNEL_DIRS})
81 SET(NB_KERNEL_DIRS_TO_IGNORE_IN_DOXYGEN
82 "${NB_KERNEL_DIRS_TO_IGNORE_IN_DOXYGEN} \\\n ${NB_KERNEL_DIR}")
83 ENDFOREACH(NB_KERNEL_DIR)
84 set(DOXYGEN_SECTIONS "")
85 CONFIGURE_FILE(Doxyfile-common.cmakein Doxyfile-common)
86 CONFIGURE_FILE(Doxyfile-full.cmakein Doxyfile-full)
87 CONFIGURE_FILE(Doxyfile-lib.cmakein Doxyfile-lib)
88 CONFIGURE_FILE(Doxyfile-user.cmakein Doxyfile-user)
89 CONFIGURE_FILE(Doxyfile-xml.cmakein Doxyfile-xml)
91 if (GMX_COMPACT_DOXYGEN)
92 FILE(APPEND ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile-common
93 "@INCLUDE = ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile-compact\n")
96 FILE(COPY index.html DESTINATION ${CMAKE_CURRENT_BINARY_DIR})
97 configure_file(RunDoxygen.cmake.cmakein RunDoxygen.cmake @ONLY)
98 add_custom_target(doc-full
99 ${CMAKE_COMMAND} -DDOCTYPE=full -P RunDoxygen.cmake
100 WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
101 COMMENT "Generating full documentation with Doxygen" VERBATIM)
102 add_custom_target(doc-lib
103 ${CMAKE_COMMAND} -DDOCTYPE=lib -P RunDoxygen.cmake
104 WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
105 COMMENT "Generating library documentation with Doxygen" VERBATIM)
106 add_custom_target(doc-user
107 ${CMAKE_COMMAND} -DDOCTYPE=user -P RunDoxygen.cmake
108 WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
109 COMMENT "Generating public API documentation with Doxygen" VERBATIM)
110 add_custom_target(doc-xml
111 ${CMAKE_COMMAND} -DDOCTYPE=xml -P RunDoxygen.cmake
112 WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
113 COMMENT "Extracting Doxygen documentation to XML" VERBATIM)
114 add_custom_target(doc-all)
115 add_dependencies(doc-all doc-full doc-lib doc-user)
117 if (GMX_GIT_VERSION_INFO)
118 add_custom_target(doxygen-version
119 COMMAND ${CMAKE_COMMAND}
120 -D GIT_EXECUTABLE="${GIT_EXECUTABLE}"
121 -D PROJECT_VERSION="${PROJECT_VERSION}"
122 -D PROJECT_SOURCE_DIR="${PROJECT_SOURCE_DIR}"
123 -D VERSION_CMAKEIN="${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile-version.cmakein"
124 -D VERSION_OUT="${CMAKE_CURRENT_BINARY_DIR}/Doxyfile-version"
125 -D VERSION_NO_REMOTE_HASH=
126 -P ${CMAKE_SOURCE_DIR}/cmake/gmxGenerateVersionInfo.cmake
127 WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
128 DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile-version.cmakein
129 COMMENT "Generating version information for Doxygen")
130 add_dependencies(doc-full doxygen-version)
131 add_dependencies(doc-lib doxygen-version)
132 add_dependencies(doc-user doxygen-version)
133 add_dependencies(doc-xml doxygen-version)
135 set(GMX_PROJECT_VERSION_STR ${PROJECT_VERSION})
136 configure_file(Doxyfile-version.cmakein Doxyfile-version)
139 if (USE_PYTHON_SCRIPTS)
140 # TODO: Consider whether this is the best name and location for this
141 # code, since not all of it is Doxygen-specific (but nearly all of it
142 # relies on the Doxygen XML documentation).
143 set(doc_check_command
144 ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/doxygen-check.py
145 -S ${CMAKE_SOURCE_DIR} -B ${CMAKE_BINARY_DIR}
146 --installed ${CMAKE_CURRENT_BINARY_DIR}/installed-headers.txt
147 -l ${CMAKE_CURRENT_BINARY_DIR}/doxygen-check.log
148 --ignore ${CMAKE_CURRENT_SOURCE_DIR}/suppressions.txt
149 --ignore-cycles ${CMAKE_CURRENT_SOURCE_DIR}/cycle-suppressions.txt)
150 add_custom_target(doc-check COMMAND ${doc_check_command}
151 COMMENT "Checking Doxygen documentation" VERBATIM)
152 add_dependencies(doc-check doc-xml find-installed-headers)
154 set(graphdir ${CMAKE_CURRENT_BINARY_DIR}/depgraphs)
155 set(dep_graphs_command_python
156 ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/graphbuilder.py
157 -S ${CMAKE_SOURCE_DIR} -B ${CMAKE_BINARY_DIR}
158 --installed ${CMAKE_CURRENT_BINARY_DIR}/installed-headers.txt
159 --ignore-cycles ${CMAKE_CURRENT_SOURCE_DIR}/cycle-suppressions.txt
160 -o ${CMAKE_CURRENT_BINARY_DIR}/depgraphs)
161 set(dep_graphs_command_dot
162 ${CMAKE_COMMAND} -DGRAPHDIR=${graphdir}
163 -DDOT_EXECUTABLE=${DOXYGEN_DOT_EXECUTABLE}
164 -P ${CMAKE_CURRENT_SOURCE_DIR}/generateGraphs.cmake)
165 add_custom_target(dep-graphs
166 COMMAND ${dep_graphs_command_python}
167 COMMAND ${dep_graphs_command_dot}
168 COMMENT "Generating include dependency graphs" VERBATIM)
169 add_dependencies(dep-graphs doc-xml find-installed-headers)
171 # These targets are the same as above, but they don't rerun the
172 # dependencies each time, making it faster and more convenient for
174 add_custom_target(doc-check-fast COMMAND ${doc_check_command}
175 COMMENT "Checking Doxygen documentation" VERBATIM)
176 add_custom_target(dep-graphs-fast
177 COMMAND ${dep_graphs_command_python}
178 COMMAND ${dep_graphs_command_dot}
179 COMMENT "Generating include dependency graphs" VERBATIM)