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/managing-simulations.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
130 user-guide/cmdline.rst
131 user-guide/environment-variables.rst
132 user-guide/plotje.gif
138 include(SphinxMacros.cmake)
139 gmx_init_sphinx_setup(${SPHINX_INPUT_DIR})
141 set(SPHINX_CONFIG_VARS_FILE ${SPHINX_INPUT_DIR}/conf-vars.py)
142 gmx_configure_version_file(conf-vars.py.cmakein ${SPHINX_CONFIG_VARS_FILE}
144 SPHINX_EXTENSION_PATH RELENG_PATH
145 EXPECTED_DOXYGEN_VERSION
146 CMAKE_MINIMUM_REQUIRED_VERSION REQUIRED_CUDA_VERSION
147 REQUIRED_OPENCL_MIN_VERSION
148 REQUIRED_CUDA_COMPUTE_CAPABILITY REGRESSIONTEST_VERSION
149 SOURCE_MD5SUM REGRESSIONTEST_MD5SUM_STRING
150 GMX_TNG_MINIMUM_REQUIRED_VERSION
151 GMX_LMFIT_MINIMUM_REQUIRED_VERSION
152 COMMENT "Configuring Sphinx configuration file")
153 gmx_add_sphinx_input_file(${SPHINX_CONFIG_VARS_FILE})
154 gmx_add_sphinx_source_files(FILES ${SPHINX_SOURCE_FILES})
155 if (EXISTS ${RELENG_PATH}/docs/FileList.cmake)
156 include(${RELENG_PATH}/docs/FileList.cmake)
157 gmx_add_sphinx_source_files(
158 FROM ${RELENG_PATH}/docs TO dev-manual/releng PREFIX releng/docs/
159 FILES ${RELENG_SPHINX_FILES})
161 gmx_add_sphinx_source_files(FILES
162 dev-manual/releng/index.rst
163 dev-manual/releng/jenkins-howto.rst
164 dev-manual/releng/jenkins-ui.rst
167 gmx_add_sphinx_input_target(sphinx-input)
168 # Remove other rst files from the build tree, since they confuse Sphinx.
169 # Skip generated files in onlinehelp/, and fragments.
170 # The latter do not cause issues with obsolete files, as they
171 # are not considered as Sphinx input files, but will only be
172 # included using an explicit .. include::.
173 gmx_remove_obsolete_sphinx_input_files("^(onlinehelp|fragments)/.*\\\\.rst$")
175 # TODO: Make this remove obsolete .rst files.
176 # TODO: This does not work in cross-compilation scenarios; disable up to
177 # the necessary level.
178 gmx_add_custom_output_target(sphinx-programs OUTPUT STAMP
179 COMMAND ${CMAKE_COMMAND} -E make_directory onlinehelp
180 COMMAND gmx -quiet help -export rst
182 WORKING_DIRECTORY ${SPHINX_INPUT_DIR}
183 COMMENT "Generating reStructuredText help")
184 # This dependency ensures that the directories exist before the
185 # executable tries to write things there.
186 add_dependencies(sphinx-programs sphinx-input)
188 # Make the INSTALL file for CPack for the tarball. This gets put
189 # into the tarball via the CPack rules below, which requires that
190 # the INSTALL file is in a separate directory by itself.
191 set(TEXT_INSTALL_GUIDE_OUTPUT_DIR "install-guide/text")
192 add_custom_target(install-guide
196 -w sphinx-install.log
197 -d ${CMAKE_CURRENT_BINARY_DIR}/install-guide/_doctrees
198 -c ${SPHINX_INPUT_DIR}
199 "${SPHINX_INPUT_DIR}/install-guide"
200 "${TEXT_INSTALL_GUIDE_OUTPUT_DIR}"
202 ${CMAKE_COMMAND} -E rename
203 ${TEXT_INSTALL_GUIDE_OUTPUT_DIR}/index.txt
204 ${TEXT_INSTALL_GUIDE_OUTPUT_DIR}/INSTALL
206 ${CMAKE_CURRENT_BINARY_DIR}
207 COMMENT "Building INSTALL with Sphinx"
210 add_dependencies(install-guide sphinx-input)
211 gmx_cpack_add_generated_source_directory(install-guide/text DESTINATION /)
213 # Sphinx cache with pickled ReST documents
214 set(SPHINX_CACHE_DIR "${CMAKE_CURRENT_BINARY_DIR}/_doctrees")
216 add_custom_target(webpage-sphinx
218 ${CMAKE_COMMAND} -E make_directory ${SPHINX_INPUT_DIR}/_static
223 -d "${SPHINX_CACHE_DIR}"
224 "${SPHINX_INPUT_DIR}"
227 ${CMAKE_CURRENT_BINARY_DIR}
228 COMMENT "Building HTML documentation with Sphinx"
231 add_dependencies(webpage-sphinx sphinx-input sphinx-programs)
233 add_custom_target(man
238 -d ${SPHINX_CACHE_DIR}
241 ${CMAKE_CURRENT_BINARY_DIR}/man
242 COMMENT "Building man pages with Sphinx"
244 add_dependencies(man sphinx-input sphinx-programs)
246 # If requested, install the man pages built by the 'man' target
247 # created above. Nothing will be installed if the user did not
248 # manually build the target.
249 set(MAN_PAGE_DIR ${CMAKE_CURRENT_BINARY_DIR})
252 add_custom_target(webpage-sphinx
253 COMMAND ${CMAKE_COMMAND} -E echo
254 "HTML pages cannot be built because Sphinx is not available"
256 add_custom_target(install-guide
257 COMMAND ${CMAKE_COMMAND} -E echo
258 "INSTALL cannot be built because Sphinx is not available"
260 add_custom_target(man
261 COMMAND ${CMAKE_COMMAND} -E echo
262 "man pages cannot be built because Sphinx is not available"
267 set(MAN_PAGE_DIR ${MAN_PAGE_DIR}/man)
268 # Trailing slash on directory is significant for
269 # install(DIRECTORY). See CMake docs.
270 install(DIRECTORY ${MAN_PAGE_DIR}/
271 DESTINATION ${MAN_INSTALL_DIR}/man1
272 COMPONENT man OPTIONAL
273 FILES_MATCHING PATTERN "*.1")
275 gmx_cpack_add_generated_source_directory(man)
277 # Determine whether we can build all the HTML pages and content linked from
278 # there. If not, construct an informative message if the user tries to
279 # build the target; most people never need to know, unless they've asked for
281 set(HTML_BUILD_IS_POSSIBLE ON)
282 set(HTML_BUILD_NOT_POSSIBLE_REASON)
283 set(HTML_BUILD_WARNINGS)
285 # Next, turn it off if any of the preconditions are unsatisified
286 if (NOT PYTHON_EXECUTABLE)
287 set(HTML_BUILD_IS_POSSIBLE OFF)
288 set(HTML_BUILD_NOT_POSSIBLE_REASON "Python is required")
289 elseif (NOT SPHINX_FOUND)
290 # Hardly anything gets built if Sphinx is not available, so don't bother.
291 set(HTML_BUILD_IS_POSSIBLE OFF)
292 set(HTML_BUILD_NOT_POSSIBLE_REASON "Sphinx is required")
294 if (NOT MANUAL_BUILD_IS_POSSIBLE)
295 list(APPEND HTML_BUILD_WARNINGS
296 "Reference PDF manual was not built, so links to it do not work")
298 if (NOT DOXYGEN_EXECUTABLE)
299 list(APPEND HTML_BUILD_WARNINGS
300 "Doxygen was not available, so links to Doxygen do not work")
302 if (NOT DOXYGEN_DOT_EXECUTABLE)
303 list(APPEND HTML_BUILD_WARNINGS
304 "dot/graphviz was not found, so some graphs are missing")
307 if (HTML_BUILD_IS_POSSIBLE)
308 set(_webpage_target_properties)
309 if (HTML_BUILD_WARNINGS)
310 list(APPEND _webpage_target_properties
311 COMMAND ${CMAKE_COMMAND} -E echo
312 "webpage was built, but with the following limitations:")
313 foreach(_warning ${HTML_BUILD_WARNINGS})
314 list(APPEND _webpage_target_properties
315 COMMAND ${CMAKE_COMMAND} -E echo " - ${_warning}")
319 if (MANUAL_BUILD_IS_POSSIBLE)
320 # Make the PDF reference guide
321 # TODO Try to make the PDF arrive directly in ${HTML_OUTPUT_DIR}
322 # TODO Make this depend on the output of the manual build, so that the
323 # file actually gets copied multiple times.
324 set(_manual_target_location ${HTML_OUTPUT_DIR}/manual-${GMX_VERSION_STRING}.pdf)
326 OUTPUT ${_manual_target_location}
327 COMMAND ${CMAKE_COMMAND}
328 -E remove -f ${_manual_target_location}
329 COMMAND ${CMAKE_COMMAND}
330 -E copy ${CMAKE_CURRENT_BINARY_DIR}/manual/gromacs.pdf ${_manual_target_location}
333 list(APPEND _webpage_target_properties
334 DEPENDS ${_manual_target_location})
337 # The Doxygen configuration in doxygen/Doxyfile-common.cmakein
338 # makes all the Doxygen output directly in
339 # ${HTML_OUTPUT_DIR}/doxygen (and makes the directory if it needs
342 # Add a top-level target that builds everything related to the webpage,
343 # for Jenkins (and possibly others) to use
344 add_custom_target(webpage ${_webpage_target_properties}
345 COMMENT "Building webpage"
347 add_dependencies(webpage webpage-sphinx doxygen-all)
349 add_custom_target(webpage
350 COMMAND ${CMAKE_COMMAND} -E echo
351 "Cannot build webpage because ${HTML_BUILD_NOT_POSSIBLE_REASON}"
352 COMMENT "Webpage build not possible"