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,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.
   8 #
   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.
  13 #
  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.
  18 #
  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.
  23 #
  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.
  31 #
  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.
  34
  35 if(MANUAL_BUILD_IS_POSSIBLE)
  36     add_custom_command(
  37         OUTPUT ${SPHINX_LATEX_FILE}
  38         DEPENDS sphinx-programs sphinx-input
  39         COMMAND
  40             ${SPHINX_EXECUTABLE}
  41             -q -b latex
  42             -w sphinx-latex.log
  43             -d "${SPHINX_CACHE_DIR}"
  44             "${SPHINX_INPUT_DIR}"
  45             "${TEX_OUTPUT_DIR}"
  46         WORKING_DIRECTORY
  47             ${CMAKE_CURRENT_BINARY_DIR}
  48         COMMENT "Preparing PDF manual LaTeX input files"
  49         VERBATIM
  50         )
  51
  52
  53     LATEX_GET_OUTPUT_PATH(output_dir)
  54
  55     # Avoid generating a global "html" target that clashes with the
  56     # html target from program generation of help text in share/html.
  57     set(LATEX2HTML_CONVERTER off)
  58
  59     # This helps make the index look decent.
  60     set(MAKEINDEX_COMPILER_FLAGS -s ${CMAKE_CURRENT_SOURCE_DIR}/hfill.ist)
  61     # UseLATEX.cmake is hacked to call Anton Feenstra's subindex script
  62     # to improve the index generation and to use the Sphinx generated
  63     # gromacs.tex file. Don't replace UseLATEX.cmake
  64     # blindly from upstream!
  65
  66     # An explicit "make manual" will still be required for the manual
  67     # to be built.
  68
  69     # TODO The whole script needs to be part of a subprocess called at make
  70     # time so that the generated gromacs.tex file is available for ADD_LATEX_DOCUMENT
  71     # when it searches for it.
  72     # Note: The gromacs.tex file is not actually copied by the UseLatex.cmake script,
  73     # but generated by Sphinx during the make step.
  74     ADD_LATEX_DOCUMENT(gromacs.tex
  75         DEPENDS ${SPHINX_LATEX_FILE}
  76         DEFAULT_PDF
  77         )
  78
  79     # Finally, the command to build the manual.
  80
  81     add_custom_target(manual
  82         DEPENDS pdf
  83         )
  84 else()
  85         add_custom_target(manual
  86         COMMAND ${CMAKE_COMMAND} -E echo
  87         "Cannot build PDF manual, because ${MANUAL_BUILD_NOT_POSSIBLE_REASON}"
  88         VERBATIM)
  89 endif()