diff --git a/doc/buildsystem.rst b/doc/buildsystem.rst index 7f975230cc64e605d3b77f8ef48eaf322bb69459..ac23b70c3bd51d49509b710ab096fce7266829df 100644 --- a/doc/buildsystem.rst +++ b/doc/buildsystem.rst @@ -23,15 +23,16 @@ Building |project| Dependencies -------------------------------------------------------------------------------- -|project| is build on top of |ost_l|_ (|ost_s|), requiring at least version 1.8. -|ost_s| must be configured and compiled with ``ENABLE_MM=1`` to use |openmm|_. -To create the build system, |cmake|_ is required. The same versions of |python|_ -and |boost|_ are needed as used in |ost_s|. For |eigen3|_ we need at least -version 3.3.0. To build the documentation, |sphinx|_ is required. +|project| is build on top of |ost_l|_ (|ost_s|), requiring at least version +|ost_version|. |ost_s| must be configured and compiled with ``ENABLE_MM=1`` to +use |openmm|_. To create the build system, |cmake|_ is required. The same +versions of |python|_ and |boost|_ are needed as used in |ost_s|. For |eigen3|_ +we need at least version 3.3.0. To build the documentation, |sphinx|_ is +required. The currently preferred versions are: -* |ost_s|_ 1.9 +* |ost_s|_ |ost_version| * |openmm|_ 7.1.1 * |cmake|_ 2.8.12 * |python|_ 2.7.5 diff --git a/doc/conf.py.in b/doc/conf.py.in index cde5afda03930cfadbf17534b44dda1fd0e6fafd..49f9385d8c0584731e1fb6d4a24db3235d3fb3ca 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -286,6 +286,7 @@ rst_epilog = """ .. |cmake| replace:: CMake .. |ost_l| replace:: OpenStructure .. |ost_s| replace:: OST +.. |ost_version| replace:: 1.10.0 .. |python| replace:: Python .. |sphinx| replace:: Sphinx .. _sphinx: http://sphinx-doc.org/ diff --git a/scripts/bump-version.py b/scripts/bump-version.py index 2b496447e6a8914fa1a5b75e030ce54f3ac69fb1..112216a30217e41fbdd6d364988b08660b56bcb6 100644 --- a/scripts/bump-version.py +++ b/scripts/bump-version.py @@ -42,3 +42,10 @@ for i, line in enumerate(lines): lines[i] = 'ARG PROMOD_VERSION="%s"\n' % version_string open("container/Dockerfile", "w").writelines(lines) # note: Singularity recipe takes Docker as input so all good + +# fix doc config +lines = open("doc/conf.py.in").readlines() +for i, line in enumerate(lines): + if line.startswith(".. |ost_version| replace::"): + lines[i] = '.. |ost_version| replace:: %s\n' % ost_version_string +open("doc/conf.py.in", "w").writelines(lines)