2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 2014,2015, 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 # Note that the user-guide target, etc. can still be built
36 # independent of the webpage target.
37 if(MARKDOWN_CONFIGURE_IS_POSSIBLE AND PANDOC_EXECUTABLE)
38 set(name "user-guide")
39 configure_markdown(main.md)
40 configure_markdown(references.md)
42 # TODO The concatenation of the markdown into a single document on
43 # the pandoc command line generated by CMake is not pretty, but
44 # there's no standard native include-file mechanism in
45 # Markdown. We should resolve this when we agree on a final
46 # generation platform.
47 list(APPEND list_of_markdown_files
48 ${CMAKE_CURRENT_SOURCE_DIR}/getting-started.md
49 ${CMAKE_CURRENT_SOURCE_DIR}/tools.md
50 ${CMAKE_CURRENT_SOURCE_DIR}/mdp-options.md
51 ${CMAKE_CURRENT_SOURCE_DIR}/cutoff-schemes.md
52 ${CMAKE_CURRENT_SOURCE_DIR}/mdrun-features.md
53 ${CMAKE_CURRENT_SOURCE_DIR}/mdrun-performance.md
54 ${CMAKE_CURRENT_SOURCE_DIR}/file-formats.md
55 ${CMAKE_CURRENT_SOURCE_DIR}/environment-variables.md
58 make_markdown_html(${name} ${CMAKE_CURRENT_BINARY_DIR}/main.md ${list_of_markdown_files} ${CMAKE_CURRENT_BINARY_DIR}/references.md)
59 make_markdown_pdf(${name} ${CMAKE_CURRENT_BINARY_DIR}/main.md ${list_of_markdown_files} ${CMAKE_CURRENT_BINARY_DIR}/references.md)
61 # Add a top-level target for the webpage build to hook onto
62 add_custom_target(${name}
64 ${HTML_OUTPUT_DIR}/${name}.html
65 ${HTML_OUTPUT_DIR}/${name}.pdf