docs/manual/CMakeLists.txt

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2014,2015,2016,2017,2018 by the GROMACS development team.
   5 # Copyright (c) 2019,2020, by the GROMACS development team, led by
   6 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7 # and including many others, as listed in the AUTHORS file in the
   8 # top-level source directory and at http://www.gromacs.org.
   9 #
  10 # GROMACS is free software; you can redistribute it and/or
  11 # modify it under the terms of the GNU Lesser General Public License
  12 # as published by the Free Software Foundation; either version 2.1
  13 # of the License, or (at your option) any later version.
  14 #
  15 # GROMACS is distributed in the hope that it will be useful,
  16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 # Lesser General Public License for more details.
  19 #
  20 # You should have received a copy of the GNU Lesser General Public
  21 # License along with GROMACS; if not, see
  22 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24 #
  25 # If you want to redistribute modifications to GROMACS, please
  26 # consider that scientific software is very special. Version
  27 # control is crucial - bugs must be traceable. We will be happy to
  28 # consider code for inclusion in the official distribution, but
  29 # derived work must not be called official GROMACS. Details are found
  30 # in the README & COPYING files - if they are missing, get the
  31 # official version at http://www.gromacs.org.
  32 #
  33 # To help us fund GROMACS development, we humbly ask that you cite
  34 # the research papers on the package. Check out http://www.gromacs.org.
  35
  36 if(MANUAL_BUILD_IS_POSSIBLE)
  37     add_custom_command(
  38         OUTPUT ${SPHINX_LATEX_FILE}
  39         DEPENDS sphinx-programs sphinx-input
  40         COMMAND
  41             ${SPHINX_EXECUTABLE}
  42             -q -b latex
  43             -w sphinx-latex.log
  44             -d "${SPHINX_CACHE_DIR}"
  45             "${SPHINX_INPUT_DIR}"
  46             "${TEX_OUTPUT_DIR}"
  47         WORKING_DIRECTORY
  48             ${CMAKE_CURRENT_BINARY_DIR}
  49         COMMENT "Preparing PDF manual LaTeX input files"
  50         VERBATIM
  51         )
  52
  53
  54     LATEX_GET_OUTPUT_PATH(output_dir)
  55
  56     # Avoid generating a global "html" target that clashes with the
  57     # html target from program generation of help text in share/html.
  58     set(LATEX2HTML_CONVERTER off)
  59
  60     # This helps make the index look decent.
  61     set(MAKEINDEX_COMPILER_FLAGS -s ${CMAKE_CURRENT_SOURCE_DIR}/hfill.ist)
  62     # UseLATEX.cmake is hacked to call Anton Feenstra's subindex script
  63     # to improve the index generation and to use the Sphinx generated
  64     # gromacs.tex file. Don't replace UseLATEX.cmake
  65     # blindly from upstream!
  66
  67     # An explicit "make manual" will still be required for the manual
  68     # to be built.
  69
  70     # TODO The whole script needs to be part of a subprocess called at make
  71     # time so that the generated gromacs.tex file is available for ADD_LATEX_DOCUMENT
  72     # when it searches for it.
  73     # Note: The gromacs.tex file is not actually copied by the UseLatex.cmake script,
  74     # but generated by Sphinx during the make step.
  75     ADD_LATEX_DOCUMENT(gromacs.tex
  76         DEPENDS ${SPHINX_LATEX_FILE}
  77         DEFAULT_PDF
  78         )
  79
  80     # Finally, the command to build the manual.
  81
  82     add_custom_target(manual
  83         DEPENDS pdf
  84         )
  85 else()
  86         add_custom_target(manual
  87         COMMAND ${CMAKE_COMMAND} -E echo
  88         "Cannot build PDF manual, because ${MANUAL_BUILD_NOT_POSSIBLE_REASON}"
  89         VERBATIM)
  90 endif()