2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 2014,2015,2016,2017, 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 set(SOURCE_MD5SUM "unknown" CACHE STRING
55 "MD5 sum of the source tarball, normally used only for the pre-release webpage build")
56 # REGRESSIONTEST_MD5SUM is set in cmake/gmxVersionInfo.cmake because it is used also in tests/CMakeLists.txt
57 mark_as_advanced(SOURCE_MD5SUM)
59 set(EXPECTED_DOXYGEN_VERSION 1.8.5)
61 if (DEFINED PYTHON_EXECUTABLE)
62 # Keep quiet on subsequent runs of cmake
63 set(PythonInterp_FIND_QUIETLY ON)
65 find_package(PythonInterp 2.7)
66 find_package(Sphinx 1.3 QUIET COMPONENTS pygments)
68 # Even if we aren't going to make the full webpage, set up to put all
69 # the documentation output in the same place, for convenience
70 set(HTML_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/html")
71 file(MAKE_DIRECTORY ${HTML_OUTPUT_DIR})
73 # The directory from which man pages will be installed; if it remains
74 # empty, they will be silently skipped.
76 if (SOURCE_IS_SOURCE_DISTRIBUTION)
77 # When building from the tarball, install the bundled man pages
78 # (unless overridden).
79 set(MAN_PAGE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
82 add_subdirectory(doxygen)
83 add_subdirectory(manual)
86 # We need to have all the Sphinx input files in a single directory, and
87 # since some of them are generated, we copy everything into the build tree,
89 set(SPHINX_INPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/sphinx-input)
90 set(SPHINX_EXTENSION_PATH ${CMAKE_CURRENT_SOURCE_DIR})
91 if (SOURCE_MD5SUM STREQUAL "unknown")
92 # But for testing the webpage build (e.g. from the repo) we
93 # need a default value.
94 set(REGRESSIONTEST_MD5SUM_STRING "unknown")
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 set(SPHINX_SOURCE_FILES
104 dev-manual/build-system.rst
105 dev-manual/doxygen.rst
106 dev-manual/formatting.rst
107 dev-manual/gmxtree.rst
108 dev-manual/includestyle.rst
109 dev-manual/jenkins.rst
110 dev-manual/language-features.rst
111 dev-manual/naming.rst
112 dev-manual/overview.rst
113 dev-manual/relocatable-binaries.rst
115 dev-manual/testutils.rst
117 dev-manual/uncrustify.rst
118 fragments/doxygen-links.rst
119 install-guide/index.rst
121 user-guide/getting-started.rst
123 user-guide/system-preparation.rst
124 user-guide/cutoff-schemes.rst
125 user-guide/mdrun-features.rst
126 user-guide/mdrun-performance.rst
127 user-guide/mdp-options.rst
128 user-guide/file-formats.rst
129 user-guide/cmdline.rst
130 user-guide/environment-variables.rst
131 user-guide/plotje.gif
137 include(SphinxMacros.cmake)
138 gmx_init_sphinx_setup(${SPHINX_INPUT_DIR})
140 set(SPHINX_CONFIG_VARS_FILE ${SPHINX_INPUT_DIR}/conf-vars.py)
141 gmx_configure_version_file(conf-vars.py.cmakein ${SPHINX_CONFIG_VARS_FILE}
143 SPHINX_EXTENSION_PATH RELENG_PATH
144 EXPECTED_DOXYGEN_VERSION
145 GMX_CMAKE_MINIMUM_REQUIRED_VERSION REQUIRED_CUDA_VERSION
146 REQUIRED_OPENCL_MIN_VERSION
147 REQUIRED_CUDA_COMPUTE_CAPABILITY REGRESSIONTEST_VERSION
148 SOURCE_MD5SUM REGRESSIONTEST_MD5SUM_STRING
149 GMX_TNG_MINIMUM_REQUIRED_VERSION
150 GMX_LMFIT_MINIMUM_REQUIRED_VERSION
151 COMMENT "Configuring Sphinx configuration file")
152 gmx_add_sphinx_input_file(${SPHINX_CONFIG_VARS_FILE})
153 gmx_add_sphinx_source_files(FILES ${SPHINX_SOURCE_FILES})
154 if (EXISTS ${RELENG_PATH}/docs/FileList.cmake)
155 include(${RELENG_PATH}/docs/FileList.cmake)
156 gmx_add_sphinx_source_files(
157 FROM ${RELENG_PATH}/docs TO dev-manual/releng PREFIX releng/docs/
158 FILES ${RELENG_SPHINX_FILES})
160 gmx_add_sphinx_source_files(FILES
161 dev-manual/releng/index.rst
162 dev-manual/releng/jenkins-howto.rst
163 dev-manual/releng/jenkins-ui.rst
166 gmx_add_sphinx_input_target(sphinx-input)
167 # Remove other rst files from the build tree, since they confuse Sphinx.
168 # Skip generated files in onlinehelp/, and fragments.
169 # The latter do not cause issues with obsolete files, as they
170 # are not considered as Sphinx input files, but will only be
171 # included using an explicit .. include::.
172 gmx_remove_obsolete_sphinx_input_files("^(onlinehelp|fragments)/.*\\\\.rst$")
174 # TODO: Make this remove obsolete .rst files.
175 # TODO: This does not work in cross-compilation scenarios; disable up to
176 # the necessary level.
177 gmx_add_custom_output_target(sphinx-programs OUTPUT STAMP
178 COMMAND ${CMAKE_COMMAND} -E make_directory onlinehelp
179 COMMAND gmx -quiet help -export rst
181 WORKING_DIRECTORY ${SPHINX_INPUT_DIR}
182 COMMENT "Generating reStructuredText help")
183 # This dependency ensures that the directories exist before the
184 # executable tries to write things there.
185 add_dependencies(sphinx-programs sphinx-input)
187 # Make the INSTALL file for CPack for the tarball. This gets put
188 # into the tarball via the CPack rules below, which requires that
189 # the INSTALL file is in a separate directory by itself.
190 set(TEXT_INSTALL_GUIDE_OUTPUT_DIR "install-guide/text")
191 add_custom_target(install-guide
195 -w sphinx-install.log
196 -d ${CMAKE_CURRENT_BINARY_DIR}/install-guide/_doctrees
197 -c ${SPHINX_INPUT_DIR}
198 "${SPHINX_INPUT_DIR}/install-guide"
199 "${TEXT_INSTALL_GUIDE_OUTPUT_DIR}"
201 ${CMAKE_COMMAND} -E rename
202 ${TEXT_INSTALL_GUIDE_OUTPUT_DIR}/index.txt
203 ${TEXT_INSTALL_GUIDE_OUTPUT_DIR}/INSTALL
205 ${CMAKE_CURRENT_BINARY_DIR}
206 COMMENT "Building INSTALL with Sphinx"
209 add_dependencies(install-guide sphinx-input)
210 gmx_cpack_add_generated_source_directory(install-guide/text DESTINATION /)
212 # Sphinx cache with pickled ReST documents
213 set(SPHINX_CACHE_DIR "${CMAKE_CURRENT_BINARY_DIR}/_doctrees")
215 add_custom_target(webpage-sphinx
217 ${CMAKE_COMMAND} -E make_directory ${SPHINX_INPUT_DIR}/_static
222 -d "${SPHINX_CACHE_DIR}"
223 "${SPHINX_INPUT_DIR}"
226 ${CMAKE_CURRENT_BINARY_DIR}
227 COMMENT "Building HTML documentation with Sphinx"
230 add_dependencies(webpage-sphinx sphinx-input sphinx-programs)
232 add_custom_target(man
237 -d ${SPHINX_CACHE_DIR}
240 ${CMAKE_CURRENT_BINARY_DIR}/man
241 COMMENT "Building man pages with Sphinx"
243 add_dependencies(man sphinx-input sphinx-programs)
245 # If requested, install the man pages built by the 'man' target
246 # created above. Nothing will be installed if the user did not
247 # manually build the target.
248 set(MAN_PAGE_DIR ${CMAKE_CURRENT_BINARY_DIR})
251 add_custom_target(webpage-sphinx
252 COMMAND ${CMAKE_COMMAND} -E echo
253 "HTML pages cannot be built because Sphinx is not available"
255 add_custom_target(install-guide
256 COMMAND ${CMAKE_COMMAND} -E echo
257 "INSTALL cannot be built because Sphinx is not available"
259 add_custom_target(man
260 COMMAND ${CMAKE_COMMAND} -E echo
261 "man pages cannot be built because Sphinx is not available"
266 set(MAN_PAGE_DIR ${MAN_PAGE_DIR}/man)
267 # Trailing slash on directory is significant for
268 # install(DIRECTORY). See CMake docs.
269 install(DIRECTORY ${MAN_PAGE_DIR}/
270 DESTINATION ${MAN_INSTALL_DIR}/man1
271 COMPONENT man OPTIONAL
272 FILES_MATCHING PATTERN "*.1")
274 gmx_cpack_add_generated_source_directory(man)
276 # Determine whether we can build all the HTML pages and content linked from
277 # there. If not, construct an informative message if the user tries to
278 # build the target; most people never need to know, unless they've asked for
280 set(HTML_BUILD_IS_POSSIBLE ON)
281 set(HTML_BUILD_NOT_POSSIBLE_REASON)
282 set(HTML_BUILD_WARNINGS)
284 # Next, turn it off if any of the preconditions are unsatisified
285 if (NOT PYTHON_EXECUTABLE)
286 set(HTML_BUILD_IS_POSSIBLE OFF)
287 set(HTML_BUILD_NOT_POSSIBLE_REASON "Python is required")
288 elseif (NOT SPHINX_FOUND)
289 # Hardly anything gets built if Sphinx is not available, so don't bother.
290 set(HTML_BUILD_IS_POSSIBLE OFF)
291 set(HTML_BUILD_NOT_POSSIBLE_REASON "Sphinx is required")
293 if (NOT MANUAL_BUILD_IS_POSSIBLE)
294 list(APPEND HTML_BUILD_WARNINGS
295 "Reference PDF manual was not built, so links to it do not work")
297 if (NOT DOXYGEN_EXECUTABLE)
298 list(APPEND HTML_BUILD_WARNINGS
299 "Doxygen was not available, so links to Doxygen do not work")
301 if (NOT DOXYGEN_DOT_EXECUTABLE)
302 list(APPEND HTML_BUILD_WARNINGS
303 "dot/graphviz was not found, so some graphs are missing")
306 if (HTML_BUILD_IS_POSSIBLE)
307 set(_webpage_target_properties)
308 if (HTML_BUILD_WARNINGS)
309 list(APPEND _webpage_target_properties
310 COMMAND ${CMAKE_COMMAND} -E echo
311 "webpage was built, but with the following limitations:")
312 foreach(_warning ${HTML_BUILD_WARNINGS})
313 list(APPEND _webpage_target_properties
314 COMMAND ${CMAKE_COMMAND} -E echo " - ${_warning}")
318 if (MANUAL_BUILD_IS_POSSIBLE)
319 # Make the PDF reference guide
320 # TODO Try to make the PDF arrive directly in ${HTML_OUTPUT_DIR}
321 # TODO Make this depend on the output of the manual build, so that the
322 # file actually gets copied multiple times.
323 set(_manual_target_location ${HTML_OUTPUT_DIR}/manual-${GMX_VERSION_STRING}.pdf)
325 OUTPUT ${_manual_target_location}
326 COMMAND ${CMAKE_COMMAND}
327 -E remove -f ${_manual_target_location}
328 COMMAND ${CMAKE_COMMAND}
329 -E copy ${CMAKE_CURRENT_BINARY_DIR}/manual/gromacs.pdf ${_manual_target_location}
332 list(APPEND _webpage_target_properties
333 DEPENDS ${_manual_target_location})
336 # The Doxygen configuration in doxygen/Doxyfile-common.cmakein
337 # makes all the Doxygen output directly in
338 # ${HTML_OUTPUT_DIR}/doxygen (and makes the directory if it needs
341 # Add a top-level target that builds everything related to the webpage,
342 # for Jenkins (and possibly others) to use
343 add_custom_target(webpage ${_webpage_target_properties}
344 COMMENT "Building webpage"
346 add_dependencies(webpage webpage-sphinx doxygen-all)
348 add_custom_target(webpage
349 COMMAND ${CMAKE_COMMAND} -E echo
350 "Cannot build webpage because ${HTML_BUILD_NOT_POSSIBLE_REASON}"
351 COMMENT "Webpage build not possible"