Merge pull request RasaHQ#5812 from RasaHQ/conf-variable

add arbitrary variable replacement in docs, use for sdk version

Author: erohmensing

docs/conf.py

@@ -66,6 +66,21 @@
 # The full version, including alpha/beta/rc tags.
 release = __version__
 
+# Variables (formatted as `|variable|`) to be replaced in the text
+# Sphinx replaces `|release|` and `|version|` by default,
+# but we have to add an `rst_epilog` to replace our own variables
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-rst_epilog
+from rasa_sdk import __version__ as rasa_sdk_version
+
+# type : Dict[Text, Text]
+variables_to_replace = {"rasa_sdk_version": rasa_sdk_version}
+
+rst_epilog = ""
+for name, value in variables_to_replace.items():
+    rst_epilog += f".. |{name}| replace:: {value}\n"
+
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #

docs/user-guide/docker/building-in-docker.rst

@@ -222,7 +222,7 @@ You can then run the actions with the following command:
 
     .. parsed-literal::
 
-      docker run -d -v $(pwd)/actions:/app/actions --net my-project --name action-server rasa/rasa-sdk:\ |version|.0
+      docker run -d -v $(pwd)/actions:/app/actions --net my-project --name action-server rasa/rasa-sdk:\ |rasa_sdk_version|
 
 
 Here's what's happening in that command:
@@ -232,7 +232,7 @@ Here's what's happening in that command:
     container so that the action server can run the code in the ``actions`` folder
   - ``net my-project``: Run the server on a specific network so that the rasa container can find it
   - ``--name action-server``: Gives the server a specific name for the rasa server to reference
-  - rasa/rasa-sdk:|version|.0 : Uses the Rasa SDK image with the tag |version|.0
+  - rasa/rasa-sdk:|rasa_sdk_version| : Uses the Rasa SDK image with the tag |rasa_sdk_version|
 
 
 Because the action server is running in detached mode, if you want to stop the container,

docs/user-guide/how-to-deploy.rst

@@ -128,7 +128,7 @@ To create your image:
       .. parsed-literal::
 
          # Extend the official Rasa SDK image
-         FROM rasa/rasa-sdk:\ |version|.0
+         FROM rasa/rasa-sdk:|rasa_sdk_version|
 
          # Use subdirectory as working directory
          WORKDIR /app