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 # This directory provides a unified place for building all kinds of
36 # GROMACS documentation. This includes some "static" content (Doxygen
37 # code documentation, reference manual, install guide, old online HTML
38 # images), and content generated from the gmx program for the various
39 # tools (man and HTML pages). It also provides the "webpage" target,
40 # that combines all of the above (except man pages in man format) into
41 # a form suitable for automated deployment to the GROMACS website. It
42 # also provides the INSTALL file for the tarball.
44 # The webpage is mostly built by Sphinx. Variable values for Sphinx
45 # substitutions are configured by CMake (for things like version numbers),
46 # using gmx_configure_version_file(). This happens during build time instead
47 # of configure time, because 1) some of the version variables are only
48 # available during build time, and 2) we don't want to do all the Sphinx setup
49 # during configuration to save some time when not building the content.
50 # All the generated values get put into conf-vars.py (generated from
51 # conf-vars.py.cmakein), which in turn is included by the Sphinx configuration
54 option(GMX_BUILD_WEBPAGE "Whether to try to configure to build the GROMACS static webpages" OFF)
55 option(GMX_BUILD_MANUAL "Whether to try to configure to build the PDF manual" OFF)
56 mark_as_advanced(GMX_BUILD_WEBPAGE GMX_BUILD_MANUAL)
58 find_package(PythonInterp)
59 find_package(Sphinx 1.2.3 COMPONENTS pygments)
61 # Even if we aren't going to make the full webpage, set up to put all
62 # the documentation output in the same place, for convenience
63 set(HTML_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/html")
64 file(MAKE_DIRECTORY ${HTML_OUTPUT_DIR})
66 # The directory from which man pages will be installed; if it remains
67 # empty, they will be silently skipped.
69 if (SOURCE_IS_SOURCE_DISTRIBUTION)
70 # When building from the tarball, install the bundled man pages
71 # (unless overridden).
72 set(MAN_PAGE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
75 add_subdirectory(doxygen)
77 set(SOURCE_MD5SUM "unknown" CACHE STRING "MD5 sum of the source tarball, normally used only for the pre-release webpage build")
78 # REGRESSIONTEST_MD5SUM is set in cmake/gmxVersionInfo.cmake because it is used also in tests/CMakeLists.txt
79 mark_as_advanced(SOURCE_MD5SUM)
82 # Make sure we only do detection of manual-building dependencies
83 # when the user opted in for that.
84 add_subdirectory(manual)
88 # We need to have all the Sphinx input files in a single directory, and
89 # since some of them are generated, we copy everything into the build tree,
91 set(SPHINX_INPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/sphinx-input)
92 set(SPHINX_CONFIG_FILE ${CMAKE_CURRENT_SOURCE_DIR}/conf.py)
93 set(SPHINX_CONFIG_VARS_FILE ${SPHINX_INPUT_DIR}/conf-vars.py)
94 set(SPHINX_EXTENSION_PATH ${CMAKE_CURRENT_SOURCE_DIR})
95 if (SOURCE_IS_SOURCE_DISTRIBUTION OR GMX_BUILD_TARBALL)
96 # The real build of the webpage happens from the tarball, and
97 # this should be set to the matching MD5 sum.
98 set(REGRESSIONTEST_MD5SUM_STRING "${REGRESSIONTEST_MD5SUM}")
100 # But for testing the webpage build (e.g. from the repo) we
101 # need a default value.
102 set(REGRESSIONTEST_MD5SUM_STRING "unknown")
104 set(SPHINX_SOURCE_FILES
108 dev-manual/codelayout.rst
109 dev-manual/doxygen.rst
110 dev-manual/doxygen-links.rst
111 dev-manual/formatting.rst
112 dev-manual/gmxtree.rst
113 dev-manual/includestyle.rst
114 dev-manual/naming.rst
115 dev-manual/overview.rst
117 dev-manual/testutils.rst
119 dev-manual/uncrustify.rst
120 install-guide/index.rst
123 user-guide/getting-started.rst
125 user-guide/cutoff-schemes.rst
126 user-guide/mdrun-features.rst
127 user-guide/mdrun-performance.rst
128 user-guide/mdp-options.rst
129 user-guide/file-formats.rst
131 user-guide/environment-variables.rst
132 user-guide/plotje.gif
138 # Remove other rst files from the build tree, since they confuse Sphinx.
139 file(GLOB_RECURSE _obsolete_sources RELATIVE ${SPHINX_INPUT_DIR}
140 ${SPHINX_INPUT_DIR}/*.rst)
141 list(REMOVE_ITEM _obsolete_sources ${SPHINX_SOURCE_FILES})
142 foreach(_file ${_obsolete_sources})
143 # Skip generated files.
144 if (NOT _file MATCHES "^(programs/.*|man/bytopic)\\.rst$")
145 message(STATUS "Removing obsolete Sphinx input ${_file}")
146 file(REMOVE ${SPHINX_INPUT_DIR}/${_file})
150 gmx_configure_version_file(conf-vars.py.cmakein ${SPHINX_CONFIG_VARS_FILE}
152 SPHINX_EXTENSION_PATH
153 GMX_CMAKE_MINIMUM_REQUIRED_VERSION REQUIRED_CUDA_VERSION
154 REQUIRED_CUDA_COMPUTE_CAPABILITY REGRESSIONTEST_VERSION
155 SOURCE_MD5SUM REGRESSIONTEST_MD5SUM_STRING
156 COMMENT "Configuring Sphinx configuration file")
157 set(SPHINX_INPUT_FILES ${SPHINX_CONFIG_VARS_FILE})
158 foreach(_file ${SPHINX_SOURCE_FILES})
160 OUTPUT ${SPHINX_INPUT_DIR}/${_file}
161 COMMAND ${CMAKE_COMMAND} -E copy
162 ${CMAKE_CURRENT_SOURCE_DIR}/${_file}
163 ${SPHINX_INPUT_DIR}/${_file}
165 ${CMAKE_CURRENT_SOURCE_DIR}/${_file}
166 COMMENT "Copying Sphinx input file ${_file}"
168 list(APPEND SPHINX_INPUT_FILES ${SPHINX_INPUT_DIR}/${_file})
170 gmx_add_custom_output_target(sphinx-input OUTPUT STAMP
171 DEPENDS ${SPHINX_INPUT_FILES})
172 # TODO: Make this remove obsolete .rst files.
173 gmx_add_custom_output_target(sphinx-programs OUTPUT STAMP
174 COMMAND ${CMAKE_COMMAND} -E make_directory programs
175 COMMAND gmx -quiet help -export rst
177 WORKING_DIRECTORY ${SPHINX_INPUT_DIR}
178 COMMENT "Generating reStructuredText help")
179 # This dependency ensures that the directories exist before the
180 # executable tries to write things there.
181 add_dependencies(sphinx-programs sphinx-input)
183 # Make the INSTALL file for CPack for the tarball. This gets put
184 # into the tarball via the CPack rules below, which requires that
185 # the INSTALL file is in a separate directory by itself.
186 set(TEXT_INSTALL_GUIDE_OUTPUT_DIR "install-guide/text")
187 add_custom_target(install-guide
191 -w sphinx-install.log
192 -d ${CMAKE_CURRENT_BINARY_DIR}/install-guide/_doctrees
193 -c ${SPHINX_INPUT_DIR}
194 "${SPHINX_INPUT_DIR}/install-guide"
195 "${TEXT_INSTALL_GUIDE_OUTPUT_DIR}"
197 ${CMAKE_COMMAND} -E rename
198 ${TEXT_INSTALL_GUIDE_OUTPUT_DIR}/index.txt
199 ${TEXT_INSTALL_GUIDE_OUTPUT_DIR}/INSTALL
201 ${CMAKE_CURRENT_BINARY_DIR}
202 COMMENT "Building INSTALL with Sphinx"
205 add_dependencies(install-guide sphinx-input)
206 gmx_cpack_add_generated_source_directory(install-guide/text DESTINATION /)
208 # Sphinx cache with pickled ReST documents
209 set(SPHINX_CACHE_DIR "${CMAKE_CURRENT_BINARY_DIR}/_doctrees")
211 add_custom_target(webpage-sphinx
213 ${CMAKE_COMMAND} -E make_directory ${SPHINX_INPUT_DIR}/_static
218 -d "${SPHINX_CACHE_DIR}"
219 "${SPHINX_INPUT_DIR}"
222 ${CMAKE_CURRENT_BINARY_DIR}
223 COMMENT "Building HTML documentation with Sphinx"
226 add_dependencies(webpage-sphinx sphinx-input sphinx-programs)
228 add_custom_target(man
233 -d ${SPHINX_CACHE_DIR}
236 ${CMAKE_CURRENT_BINARY_DIR}/man
237 COMMENT "Building man pages with Sphinx"
239 add_dependencies(man sphinx-input sphinx-programs)
241 # If requested, install the man pages built by the 'man' target
242 # created above. Nothing will be installed if the user did not
243 # manually build the target.
244 set(MAN_PAGE_DIR ${CMAKE_CURRENT_BINARY_DIR})
249 set(MAN_PAGE_DIR ${MAN_PAGE_DIR}/man)
250 # Trailing slash on directory is significant for
251 # install(DIRECTORY). See CMake docs.
252 install(DIRECTORY ${MAN_PAGE_DIR}/
253 DESTINATION ${MAN_INSTALL_DIR}/man1
254 COMPONENT man OPTIONAL
255 FILES_MATCHING PATTERN "*.1")
256 install(DIRECTORY ${MAN_PAGE_DIR}/
257 DESTINATION ${MAN_INSTALL_DIR}/man7
258 COMPONENT man OPTIONAL
259 FILES_MATCHING PATTERN "*.7")
261 gmx_cpack_add_generated_source_directory(man)
263 set(HTML_BUILD_IS_POSSIBLE OFF)
264 # We can only configure to build the webpage if the user asked for it,
265 # the build is outside of the source dir, and all the components can
266 # be built. There's no intrinsic need to be talkative if we fail -
267 # most people never need to know, unless they've asked for the webpage
269 if(GMX_BUILD_WEBPAGE)
270 set(HTML_BUILD_IS_POSSIBLE ON)
271 # Next, turn it off in any of the preconditions are unsatisified
273 if(NOT MANUAL_BUILD_IS_POSSIBLE)
274 set(HTML_BUILD_IS_POSSIBLE OFF)
275 message(STATUS "Cannot build webpage without being able to build the reference PDF manual")
278 if(NOT PYTHON_EXECUTABLE)
279 set(HTML_BUILD_IS_POSSIBLE OFF)
280 message(STATUS "Cannot build webpage without python")
284 set(HTML_BUILD_IS_POSSIBLE OFF)
285 message(STATUS "Cannot build webpage without sphinx")
288 if(NOT DOXYGEN_EXECUTABLE)
289 set(HTML_BUILD_IS_POSSIBLE OFF)
290 message(STATUS "Cannot build webpage without doxygen")
293 if(NOT DOXYGEN_MSCGEN_EXECUTABLE)
294 set(HTML_BUILD_IS_POSSIBLE OFF)
295 message(STATUS "Cannot build webpage without mscgen")
299 # TODO Get rid of the remaining content in old-html
300 add_custom_target(webpage-old-images
301 ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR}/old-html ${HTML_OUTPUT_DIR}
302 COMMENT "Copying flowchart images"
306 if(HTML_BUILD_IS_POSSIBLE)
307 # Make the PDF reference guide
308 # TODO Try to make the PDF arrive directly in ${HTML_OUTPUT_DIR}
310 OUTPUT ${HTML_OUTPUT_DIR}/manual-${GMX_VERSION_STRING}.pdf
311 COMMAND ${CMAKE_COMMAND}
312 -E remove -f ${HTML_OUTPUT_DIR}/manual-${GMX_VERSION_STRING}.pdf
313 COMMAND ${CMAKE_COMMAND}
314 -E copy ${CMAKE_CURRENT_BINARY_DIR}/manual/gromacs.pdf ${HTML_OUTPUT_DIR}/manual-${GMX_VERSION_STRING}.pdf
315 # UseLATEX.cmake makes a target called pdf, not ${CMAKE_CURRENT_BINARY_DIR}/manual/gromacs.pdf
320 # The Doxygen configuration in doxygen/Doxyfile-common.cmakein
321 # makes all the Doxygen output directly in
322 # ${HTML_OUTPUT_DIR}/doxygen (and makes the directory if it needs
325 # Add a top-level target for the others to hook onto
326 add_custom_target(webpage
328 ${HTML_OUTPUT_DIR}/manual-${GMX_VERSION_STRING}.pdf
329 ${extra_webpage_dependencies}
332 add_dependencies(webpage webpage-sphinx webpage-old-images doxygen-all)
334 add_custom_target(webpage
335 COMMAND ${CMAKE_COMMAND} -E echo "Cannot build webpage because of missing requirements. Check cmake status output for reasons"
336 COMMENT "Webpage build disabled"