From da92836b6cb23dca9e78ba94281065cfecd313a9 Mon Sep 17 00:00:00 2001 From: Gerardo Tauriello <gerardo.tauriello@unibas.ch> Date: Tue, 2 Jul 2019 16:45:16 +0200 Subject: [PATCH] SCHWED-4327: Link to container recipes for current OST version. --- doc/conf/conf.py | 9 +++++++++ modules/doc/install.rst | 3 +-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/doc/conf/conf.py b/doc/conf/conf.py index 7600179f9..7a7fa741f 100644 --- a/doc/conf/conf.py +++ b/doc/conf/conf.py @@ -209,3 +209,12 @@ latex_documents = [ # If false, no module index is generated. #latex_use_modindex = True + +# -- OST specific configuration -------------------------------------------- + +# these links can be fed via Python and are added to all rst files +# -> container instructions on GIT for current OST version (assumed to match tag!) +rst_epilog = """ +.. _Docker instructions: https://git.scicore.unibas.ch/schwede/openstructure/tree/%s/docker +.. _Singularity instructions: https://git.scicore.unibas.ch/schwede/openstructure/tree/%s/singularity +""" % (ost.VERSION, ost.VERSION) diff --git a/modules/doc/install.rst b/modules/doc/install.rst index d9b3580cc..1e6b8a0ee 100644 --- a/modules/doc/install.rst +++ b/modules/doc/install.rst @@ -9,8 +9,7 @@ container solution. We provide recipes to build images for `Docker <https://www.docker.com/>`_ and `Singularity <https://www.sylabs.io/guides/2.5.1/user-guide>`_. The latest recipes and instructions can be found on our GitLab site -(`Docker instructions <https://git.scicore.unibas.ch/schwede/openstructure/tree/develop/docker>`_ and -`Singularity instructions <https://git.scicore.unibas.ch/schwede/openstructure/tree/develop/singularity>`_). +(`Docker instructions`_ and `Singularity instructions`_). If you wish to compile OpenStructure outside of a container, you need to follow the steps which we describe in detail below. In essence, these steps are: -- GitLab