Dynamically insert mss version and search result

docs/conf.py

@@ -15,6 +15,8 @@
 import sys
 import logging
 import setuptools
+import subprocess
+from string import Template
 
 if os.getenv("PROJ_LIB") is None or os.getenv("PROJ_LIB") == "PROJ_LIB":
     conda_file_dir = setuptools.__file__
@@ -117,6 +119,20 @@
 # The full version, including alpha/beta/rc tags.
 release = __version__
 
+# Replace $variables in the .rst files if on a readthedocs worker
+if "/home/docs/checkouts" in " ".join(sys.argv):
+    mss_search = subprocess.run(["conda", "search", "-c", "conda-forge", "mss"], stdout=subprocess.PIPE,
+                                stderr=subprocess.STDOUT, encoding="utf8").stdout
+    mss_search = "   ".join([line for line in mss_search.splitlines(True) if line.startswith("mss ")][-2:])
+
+    for file in os.listdir():
+        if file.endswith(".rst"):
+            with open(file, "r") as rst:
+                content = Template(rst.read())
+            with open(file, "w") as rst:
+                rst.write(content.safe_substitute(mss_version=version[:-1] if version[-1] == "." else version,
+                                                  mss_search=mss_search))
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #

docs/development.rst

@@ -9,7 +9,7 @@
 2. Software requirement
   | Python
   | `Additional Requirements <https://github.com/Open-MSS/MSS/blob/develop/requirements.d/development.txt>`_
-  
+
 
 3. Skill set
   | Knowledge of git & github
@@ -22,7 +22,7 @@ Setting Up local Environement
 ============================
 Forking the Repo
 ============================
-1. Firstly you have to make your own copy of project. For that you have to fork the repository. You can find the fork button on the top-right side of the browser window. 
+1. Firstly you have to make your own copy of project. For that you have to fork the repository. You can find the fork button on the top-right side of the browser window.
 
 2. Kindly wait till it gets forked.
 
@@ -145,7 +145,7 @@ Create an environment and install the whole mss package dependencies then remove
 
   $ conda create -n mssdev mamba
   $ conda activate mssdev
-  $ mamba install mss=4.0.1 --only-deps
+  $ mamba install mss=$mss_version --only-deps
 
 You can also use conda to install mss, but mamba is a way faster.
 Compare versions used in the meta.yaml between stable and develop branch and apply needed changes.
@@ -282,7 +282,7 @@ If you don't have a stable branch, create one first or change to that branch::
 Merging stable into develop
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Bug fixes we have done in stable we need to merge regulary into develop too:: 
+Bug fixes we have done in stable we need to merge regulary into develop too::
 
    git checkout stable
    git pull git@github.com:Open-MSS/MSS.git stable

docs/installation.rst

@@ -56,7 +56,7 @@ leave out the 'source' here and below). ::
 
     $ conda create -n mssenv mamba
     $ conda activate mssenv
-    (mssenv) $ mamba install mss=4.0.1 python
+    (mssenv) $ mamba install mss=$mss_version python
 
 
 You need to reactivate after the installation once the environment to setup all needed enironment
@@ -82,8 +82,7 @@ search for MSS what you can get ::
 
    (mssenv) $ mamba search mss
    ...
-   mss                            4.0.1  py38h578d9bd_0  conda-forge
-   mss                            4.0.1  py39hf3d152e_0  conda-forge
+   $mss_search
 
 compare what you have installed ::
 
@@ -93,9 +92,9 @@ compare what you have installed ::
 
 
 We have reports that often an update suceeds by using the install option and the new version number,
-in this example 4.0.1 and python as second option ::
+in this example $mss_version and python as second option ::
 
-   (mssenv) $ mamba install mss=4.0.1 python
+   (mssenv) $ mamba install mss=$mss_version python
 
 All attemmpts show what you get if you continue. **Continue only if you get what you want.**
 
@@ -123,7 +122,7 @@ We suggest to create a mss user.
 * login again or export PATH="/home/mss/miniconda3/bin:$PATH"
 * conda create -n mssenv mamba
 * conda activate mssenv
-* mamba install mss=4.0.1 python
+* mamba install mss=$mss_version python
 
 For a simple test you could start the builtin standalone *mswms* and *mscolab* server::