2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 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(gmxCustomCommandUtilities)
39 set(HTML_PAGE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/${OUTPUT_DIR})
41 # Unlike the man and completion targets, this target is not built
42 # automatically with GMX_BUILD_HELP=AUTO, since most people will not
44 file(GLOB_RECURSE deps
45 ${CMAKE_CURRENT_SOURCE_DIR}/images/*
46 ${CMAKE_CURRENT_SOURCE_DIR}/*.html
47 ${CMAKE_CURRENT_SOURCE_DIR}/*.css
50 ${CMAKE_CURRENT_SOURCE_DIR}/BuildHtmlHelp.cmake
51 ${CMAKE_CURRENT_SOURCE_DIR}/header.html.in
52 ${CMAKE_CURRENT_SOURCE_DIR}/links.dat
55 gmx_add_custom_output_target(html OUTPUT STAMP
56 COMMAND ${CMAKE_COMMAND}
57 -D GMX_EXECUTABLE=$<TARGET_FILE:gmx>
58 -D SOURCE_HTML_DIR=${CMAKE_CURRENT_SOURCE_DIR}
59 -D OUTPUT_DIR=${OUTPUT_DIR}
60 -P ${CMAKE_CURRENT_SOURCE_DIR}/BuildHtmlHelp.cmake
61 WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
63 COMMENT "Generating HTML help")
65 if (GMX_BUILD_HELP_FORCE)
66 set_target_properties(html PROPERTIES EXCLUDE_FROM_ALL OFF)
68 set_directory_properties(PROPERTIES
69 ADDITIONAL_MAKE_CLEAN_FILES "${OUTPUT_DIR};header.html")
70 set(HTML_PAGE_DIR ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_DIR})
73 if (SOURCE_IS_SOURCE_DISTRIBUTION OR GMX_BUILD_HELP_FORCE)
74 install(DIRECTORY ${HTML_PAGE_DIR}/
75 DESTINATION ${DATA_INSTALL_DIR}/html
78 gmx_cpack_add_generated_source_directory(${OUTPUT_DIR})