Use single variable for expected Doxygen version

Put the expected Doxygen version into a single CMake variable, and use
that throughout the build system and the Sphinx documentation to make it
easier to maintain.

Change-Id: I40b6bb8a897864850ad1c7b5010ae5129e3347a1

diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
index 1654d9ddbe6663fb0d3f94ef6e12fc213410c124..8197b4fced9c0a29697bbb49b6de327d4231f7e1 100644 (file)
--- a/docs/CMakeLists.txt
+++ b/docs/CMakeLists.txt
@@ -55,6 +55,8 @@ option(GMX_BUILD_WEBPAGE "Whether to try to configure to build the GROMACS stati
 option(GMX_BUILD_MANUAL "Whether to try to configure to build the PDF manual" OFF)
 mark_as_advanced(GMX_BUILD_WEBPAGE GMX_BUILD_MANUAL)
 
+set(EXPECTED_DOXYGEN_VERSION 1.8.5)
+
 find_package(PythonInterp)
 find_package(Sphinx 1.2.3 COMPONENTS pygments)
 
@@ -150,6 +152,7 @@ if (SPHINX_FOUND)
     gmx_configure_version_file(conf-vars.py.cmakein ${SPHINX_CONFIG_VARS_FILE}
         EXTRA_VARS
             SPHINX_EXTENSION_PATH
+            EXPECTED_DOXYGEN_VERSION
             GMX_CMAKE_MINIMUM_REQUIRED_VERSION REQUIRED_CUDA_VERSION
             REQUIRED_CUDA_COMPUTE_CAPABILITY REGRESSIONTEST_VERSION
             SOURCE_MD5SUM REGRESSIONTEST_MD5SUM_STRING

diff --git a/docs/conf-vars.py.cmakein b/docs/conf-vars.py.cmakein
index d5955f04b1e1f97e891576b0caf2e0630e1d89b0..1f3e75ce4daf5fdd47c0c7c268e47e0d79f12bed 100644 (file)
--- a/docs/conf-vars.py.cmakein
+++ b/docs/conf-vars.py.cmakein
@@ -37,6 +37,7 @@ gmx_version_string = '@GMX_VERSION_STRING@'
 gmx_version_string_full = '@GMX_VERSION_STRING_FULL@'
 regressiontest_version = '@REGRESSIONTEST_VERSION@'
 variables = [
+        ('EXPECTED_DOXYGEN_VERSION', '@EXPECTED_DOXYGEN_VERSION@'),
         ('GMX_CMAKE_MINIMUM_REQUIRED_VERSION', '@GMX_CMAKE_MINIMUM_REQUIRED_VERSION@'),
         ('REQUIRED_CUDA_VERSION', '@REQUIRED_CUDA_VERSION@'),
         ('REQUIRED_CUDA_COMPUTE_CAPABILITY', '@REQUIRED_CUDA_COMPUTE_CAPABILITY@'),

diff --git a/docs/dev-manual/doxygen.rst b/docs/dev-manual/doxygen.rst
index 59f48d3d99b4b9e05b7c6be6af08957da59fa829..6d2429b0dc5813a55fbdbe3a6f4ab3136957d537 100644 (file)
--- a/docs/dev-manual/doxygen.rst
+++ b/docs/dev-manual/doxygen.rst
@@ -102,9 +102,9 @@ these subdirectories to start browsing (for |Gromacs| developers, the
 warnings are also produced as ``docs/doxygen/doxygen-*.log``, so you can inspect them after
 the run.
 
-You will need Doxygen 1.8.5 to build the current documentation.  Other versions
-may work, but likely also produce warnings.  Additionally,
-`graphviz <http://www.graphviz.org>`_ and
+You will need Doxygen |EXPECTED_DOXYGEN_VERSION| to build the current
+documentation.  Other versions may work, but likely also produce warnings.
+Additionally, `graphviz <http://www.graphviz.org>`_ and
 `mscgen <http://www.mcternan.me.uk/mscgen/>`_ are required for some graphs in
 the documentation, and ``latex`` for formulas.  Working versions are likely
 available through most package managers.  It is possible to build the

diff --git a/docs/dev-manual/tools.rst b/docs/dev-manual/tools.rst
index 6c0e125c48c7bc05cf0d080892040fb851e1cc13..46fde62b1606819bf9435df7d288c30c81fe6e2c 100644 (file)
--- a/docs/dev-manual/tools.rst
+++ b/docs/dev-manual/tools.rst
@@ -198,9 +198,9 @@ Doxygen
   `Doxygen <http://www.doxygen.org>`_ is used to extract documentation from
   source code comments.  Also some other overview
   content is laid out by Doxygen from Markdown source files.  Currently, version
-  1.8.5 is required for a warning-free build.  Thorough explanation of the
-  Doxygen setup and instructions for documenting the source code can be found on
-  a separate page: :doc:`doxygen`.
+  |EXPECTED_DOXYGEN_VERSION| is required for a warning-free build.  Thorough
+  explanation of the Doxygen setup and instructions for documenting the source
+  code can be found on a separate page: :doc:`doxygen`.
 
 graphviz (dot)
   The Doxygen documentation uses ``dot`` from `graphviz

diff --git a/docs/doxygen/RunDoxygen.cmake.cmakein b/docs/doxygen/RunDoxygen.cmake.cmakein
index 333f9253100e0b2e6f0d3ac32f3a76b105cf888c..d7910d366dade7af7c2e6612a76978ba6c0c585a 100644 (file)
--- a/docs/doxygen/RunDoxygen.cmake.cmakein
+++ b/docs/doxygen/RunDoxygen.cmake.cmakein
@@ -1,7 +1,7 @@
 #
 # This file is part of the GROMACS molecular simulation package.
 #
-# Copyright (c) 2013,2014, by the GROMACS development team, led by
+# Copyright (c) 2013,2014,2015, by the GROMACS development team, led by
 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
 # and including many others, as listed in the AUTHORS file in the
 # top-level source directory and at http://www.gromacs.org.
@@ -36,7 +36,7 @@ set(DOXYGEN_EXECUTABLE   "@DOXYGEN_EXECUTABLE@")
 set(DOXYGEN_VERSION      "@DOXYGEN_VERSION@")
 set(DOXYGEN_MSCGEN_FOUND @DOXYGEN_MSCGEN_FOUND@)
 
-set(EXPECTED_VERSION 1.8.5)
+set(EXPECTED_VERSION     "@EXPECTED_DOXYGEN_VERSION@")
 
 if (NOT DOXYGEN_VERSION VERSION_EQUAL EXPECTED_VERSION)
     message("NOTE: You are using Doxygen version ${DOXYGEN_VERSION}. "