2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 2014,2015,2016,2017,2018,2019, 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 set(EXPECTED_SPHINX_VERSION 1.4.1)
63 if (DEFINED PYTHON_EXECUTABLE)
64 # Keep quiet on subsequent runs of cmake
65 set(PythonInterp_FIND_QUIETLY ON)
67 find_package(PythonInterp 2.7)
68 find_package(Sphinx ${EXPECTED_SPHINX_VERSION} QUIET COMPONENTS pygments)
70 # Even if we aren't going to make the full webpage, set up to put all
71 # the documentation output in the same place, for convenience
72 set(HTML_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/html")
73 file(MAKE_DIRECTORY ${HTML_OUTPUT_DIR})
75 # The directory from which man pages will be installed; if it remains
76 # empty, they will be silently skipped.
78 if (SOURCE_IS_SOURCE_DISTRIBUTION)
79 # When building from the tarball, install the bundled man pages
80 # (unless overridden).
81 set(MAN_PAGE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
84 add_subdirectory(doxygen)
85 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_EXTENSION_PATH ${CMAKE_CURRENT_SOURCE_DIR})
93 if (SOURCE_MD5SUM STREQUAL "unknown")
94 # But for testing the webpage build (e.g. from the repo) we
95 # need a default value.
96 set(REGRESSIONTEST_MD5SUM_STRING "unknown")
98 # The real build of the webpage happens from the tarball, and
99 # this should be set to the matching MD5 sum.
100 set(REGRESSIONTEST_MD5SUM_STRING "${REGRESSIONTEST_MD5SUM}")
102 set(SPHINX_SOURCE_FILES
106 dev-manual/build-system.rst
107 dev-manual/commitstyle.rst
108 dev-manual/documentation-generation.rst
109 dev-manual/doxygen.rst
110 dev-manual/error-handling.rst
111 dev-manual/formatting.rst
112 dev-manual/gmxtree.rst
113 dev-manual/includestyle.rst
114 dev-manual/jenkins.rst
115 dev-manual/language-features.rst
116 dev-manual/naming.rst
117 dev-manual/overview.rst
118 dev-manual/redmine-states.png
119 dev-manual/relocatable-binaries.rst
120 dev-manual/reportstyle.rst
122 dev-manual/testutils.rst
124 dev-manual/uncrustify.rst
125 fragments/doxygen-links.rst
126 install-guide/index.rst
127 release-notes/index.rst
128 release-notes/2018/2018.7.rst
129 release-notes/2018/2018.6.rst
130 release-notes/2018/2018.5.rst
131 release-notes/2018/2018.4.rst
132 release-notes/2018/2018.3.rst
133 release-notes/2018/2018.2.rst
134 release-notes/2018/2018.1.rst
135 release-notes/2018/major/highlights.rst
136 release-notes/2018/major/features.rst
137 release-notes/2018/major/performance.rst
138 release-notes/2018/major/tools.rst
139 release-notes/2018/major/bugs-fixed.rst
140 release-notes/2018/major/removed-features.rst
141 release-notes/2018/major/portability.rst
142 release-notes/2018/major/miscellaneous.rst
143 release-notes/2016/2016.5.rst
144 release-notes/2016/2016.4.rst
145 release-notes/2016/2016.3.rst
146 release-notes/2016/2016.2.rst
147 release-notes/2016/2016.1.rst
148 release-notes/2016/major/highlights.rst
149 release-notes/2016/major/new-features.rst
150 release-notes/2016/major/performance.rst
151 release-notes/2016/major/tools.rst
152 release-notes/2016/major/bugs-fixed.rst
153 release-notes/2016/major/removed-features.rst
154 release-notes/2016/major/miscellaneous.rst
155 release-notes/older/index.rst
157 user-guide/cutoff-schemes.rst
158 user-guide/getting-started.rst
159 user-guide/force-fields.rst
162 user-guide/floating-point.rst
163 user-guide/system-preparation.rst
164 user-guide/managing-simulations.rst
165 user-guide/mdrun-features.rst
166 user-guide/mdrun-performance.rst
167 user-guide/mdp-options.rst
168 user-guide/run-time-errors.rst
169 user-guide/file-formats.rst
170 user-guide/cmdline.rst
171 user-guide/environment-variables.rst
172 user-guide/security.rst
173 user-guide/terminology.rst
174 user-guide/plotje.gif
180 include(SphinxMacros.cmake)
181 gmx_init_sphinx_setup(${SPHINX_INPUT_DIR})
183 set(SPHINX_CONFIG_VARS_FILE ${SPHINX_INPUT_DIR}/conf-vars.py)
184 gmx_configure_version_file(conf-vars.py.cmakein ${SPHINX_CONFIG_VARS_FILE}
186 SPHINX_EXTENSION_PATH RELENG_PATH
187 EXPECTED_DOXYGEN_VERSION
188 EXPECTED_SPHINX_VERSION
189 CMAKE_MINIMUM_REQUIRED_VERSION REQUIRED_CUDA_VERSION
190 REQUIRED_OPENCL_MIN_VERSION
191 REQUIRED_CUDA_COMPUTE_CAPABILITY REGRESSIONTEST_VERSION
192 SOURCE_MD5SUM REGRESSIONTEST_MD5SUM_STRING
193 GMX_TNG_MINIMUM_REQUIRED_VERSION
194 GMX_LMFIT_MINIMUM_REQUIRED_VERSION
195 COMMENT "Configuring Sphinx configuration file")
196 gmx_add_sphinx_input_file(${SPHINX_CONFIG_VARS_FILE})
197 gmx_add_sphinx_source_files(FILES ${SPHINX_SOURCE_FILES})
198 if (EXISTS ${RELENG_PATH}/docs/FileList.cmake)
199 include(${RELENG_PATH}/docs/FileList.cmake)
200 gmx_add_sphinx_source_files(
201 FROM ${RELENG_PATH}/docs TO dev-manual/releng PREFIX releng/docs/
202 FILES ${RELENG_SPHINX_FILES})
204 gmx_add_sphinx_source_files(FILES
205 dev-manual/releng/index.rst
206 dev-manual/releng/jenkins-howto.rst
207 dev-manual/releng/jenkins-ui.rst
210 gmx_add_sphinx_input_target(sphinx-input)
211 # Remove other rst files from the build tree, since they confuse Sphinx.
212 # Skip generated files in onlinehelp/, and fragments.
213 # The latter do not cause issues with obsolete files, as they
214 # are not considered as Sphinx input files, but will only be
215 # included using an explicit .. include::.
216 gmx_remove_obsolete_sphinx_input_files("^(onlinehelp|fragments)/.*\\\\.rst$")
218 # TODO: Make this remove obsolete .rst files.
219 # TODO: This does not work in cross-compilation scenarios; disable up to
220 # the necessary level.
221 gmx_add_custom_output_target(sphinx-programs OUTPUT STAMP
222 COMMAND ${CMAKE_COMMAND} -E make_directory onlinehelp
223 COMMAND gmx -quiet help -export rst
225 WORKING_DIRECTORY ${SPHINX_INPUT_DIR}
226 COMMENT "Generating reStructuredText help")
227 # This dependency ensures that the directories exist before the
228 # executable tries to write things there.
229 add_dependencies(sphinx-programs sphinx-input)
231 # Make the INSTALL file for CPack for the tarball. This gets put
232 # into the tarball via the CPack rules below, which requires that
233 # the INSTALL file is in a separate directory by itself.
234 set(TEXT_INSTALL_GUIDE_OUTPUT_DIR "install-guide/text")
235 add_custom_target(install-guide
239 -w sphinx-install.log
240 -d ${CMAKE_CURRENT_BINARY_DIR}/install-guide/_doctrees
241 -c ${SPHINX_INPUT_DIR}
242 "${SPHINX_INPUT_DIR}/install-guide"
243 "${TEXT_INSTALL_GUIDE_OUTPUT_DIR}"
245 ${CMAKE_COMMAND} -E rename
246 ${TEXT_INSTALL_GUIDE_OUTPUT_DIR}/index.txt
247 ${TEXT_INSTALL_GUIDE_OUTPUT_DIR}/INSTALL
249 ${CMAKE_CURRENT_BINARY_DIR}
250 COMMENT "Building INSTALL with Sphinx"
253 add_dependencies(install-guide sphinx-input)
254 gmx_cpack_add_generated_source_directory(install-guide/text DESTINATION /)
256 # Sphinx cache with pickled ReST documents
257 set(SPHINX_CACHE_DIR "${CMAKE_CURRENT_BINARY_DIR}/_doctrees")
259 add_custom_target(webpage-sphinx
261 ${CMAKE_COMMAND} -E make_directory ${SPHINX_INPUT_DIR}/_static
266 -d "${SPHINX_CACHE_DIR}"
267 "${SPHINX_INPUT_DIR}"
270 ${CMAKE_CURRENT_BINARY_DIR}
271 COMMENT "Building HTML documentation with Sphinx"
274 add_dependencies(webpage-sphinx sphinx-input sphinx-programs)
276 add_custom_target(man
281 -d ${SPHINX_CACHE_DIR}
284 ${CMAKE_CURRENT_BINARY_DIR}/man
285 COMMENT "Building man pages with Sphinx"
287 add_dependencies(man sphinx-input sphinx-programs)
289 # If requested, install the man pages built by the 'man' target
290 # created above. Nothing will be installed if the user did not
291 # manually build the target.
292 set(MAN_PAGE_DIR ${CMAKE_CURRENT_BINARY_DIR})
295 add_custom_target(webpage-sphinx
296 COMMAND ${CMAKE_COMMAND} -E echo
297 "HTML pages cannot be built because Sphinx version ${EXPECTED_SPHINX_VERSION} is not available"
299 add_custom_target(install-guide
300 COMMAND ${CMAKE_COMMAND} -E echo
301 "INSTALL cannot be built because Sphinx version ${EXPECTED_SPHINX_VERSION} is not available"
303 add_custom_target(man
304 COMMAND ${CMAKE_COMMAND} -E echo
305 "man pages cannot be built because Sphinx version ${EXPECTED_SPHINX_VERSION} is not available"
310 set(MAN_PAGE_DIR ${MAN_PAGE_DIR}/man)
311 # Trailing slash on directory is significant for
312 # install(DIRECTORY). See CMake docs.
313 install(DIRECTORY ${MAN_PAGE_DIR}/
314 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
315 COMPONENT man OPTIONAL
316 FILES_MATCHING PATTERN "*.1")
318 gmx_cpack_add_generated_source_directory(man)
320 # Determine whether we can build all the HTML pages and content linked from
321 # there. If not, construct an informative message if the user tries to
322 # build the target; most people never need to know, unless they've asked for
324 set(HTML_BUILD_IS_POSSIBLE ON)
325 set(HTML_BUILD_NOT_POSSIBLE_REASON)
326 set(HTML_BUILD_WARNINGS)
328 # Next, turn it off if any of the preconditions are unsatisified
329 if (NOT PYTHON_EXECUTABLE)
330 set(HTML_BUILD_IS_POSSIBLE OFF)
331 set(HTML_BUILD_NOT_POSSIBLE_REASON "Python is required")
332 elseif (NOT SPHINX_FOUND)
333 # Hardly anything gets built if Sphinx is not available, so don't bother.
334 set(HTML_BUILD_IS_POSSIBLE OFF)
335 set(HTML_BUILD_NOT_POSSIBLE_REASON "Sphinx version ${EXPECTED_SPHINX_VERSION} is required")
337 if (NOT MANUAL_BUILD_IS_POSSIBLE)
338 list(APPEND HTML_BUILD_WARNINGS
339 "Reference PDF manual was not built, so links to it do not work")
341 if (NOT DOXYGEN_EXECUTABLE)
342 list(APPEND HTML_BUILD_WARNINGS
343 "Doxygen was not available, so links to Doxygen do not work")
345 if (NOT DOXYGEN_DOT_EXECUTABLE)
346 list(APPEND HTML_BUILD_WARNINGS
347 "dot/graphviz was not found, so some graphs are missing")
350 if (HTML_BUILD_IS_POSSIBLE)
351 set(_webpage_target_properties)
352 if (HTML_BUILD_WARNINGS)
353 list(APPEND _webpage_target_properties
354 COMMAND ${CMAKE_COMMAND} -E echo
355 "webpage was built, but with the following limitations:")
356 foreach(_warning ${HTML_BUILD_WARNINGS})
357 list(APPEND _webpage_target_properties
358 COMMAND ${CMAKE_COMMAND} -E echo " - ${_warning}")
362 if (MANUAL_BUILD_IS_POSSIBLE)
363 # Make the PDF reference guide
364 # TODO Try to make the PDF arrive directly in ${HTML_OUTPUT_DIR}
365 # TODO Make this depend on the output of the manual build, so that the
366 # file actually gets copied multiple times.
367 set(_manual_target_location ${HTML_OUTPUT_DIR}/manual-${GMX_VERSION_STRING}.pdf)
369 OUTPUT ${_manual_target_location}
370 COMMAND ${CMAKE_COMMAND}
371 -E remove -f ${_manual_target_location}
372 COMMAND ${CMAKE_COMMAND}
373 -E copy ${CMAKE_CURRENT_BINARY_DIR}/manual/gromacs.pdf ${_manual_target_location}
376 list(APPEND _webpage_target_properties
377 DEPENDS ${_manual_target_location})
380 # The Doxygen configuration in doxygen/Doxyfile-common.cmakein
381 # makes all the Doxygen output directly in
382 # ${HTML_OUTPUT_DIR}/doxygen (and makes the directory if it needs
385 # Add a top-level target that builds everything related to the webpage,
386 # for Jenkins (and possibly others) to use
387 add_custom_target(webpage ${_webpage_target_properties}
388 COMMENT "Building webpage"
390 add_dependencies(webpage webpage-sphinx doxygen-all)
392 add_custom_target(webpage
393 COMMAND ${CMAKE_COMMAND} -E echo
394 "Cannot build webpage because ${HTML_BUILD_NOT_POSSIBLE_REASON}"
395 COMMENT "Webpage build not possible"