Merge pull request #67 from DiamondLightSource/version_to_pipelines

adding a comment on httomo version during yaml full pipelines generation

Author: dkazanc

docs/source/utilities/yaml_generator.rst

@@ -2,7 +2,7 @@
 
 Templates generator
 *******************
-:ref:`backends_content` can be generated automatically using the YAML generator tool `provided <https://github.com/DiamondLightSource/httomo/tree/main/scripts/yaml_templates_generator.py>`_ in the Github repo.
+:ref:`backends_content` can be generated automatically using the YAML generator tool `provided <https://github.com/DiamondLightSource/httomo-backends/blob/main/httomo_backends/scripts/yaml_pipelines_generator.py>`_ in the Github repo.
 
 The script does the following:
 

httomo_backends/scripts/yaml_pipelines_generator.py

@@ -31,6 +31,8 @@
 import httomo_backends
 import yaml
 
+from httomo import __version__ as httomo_version
+
 CS = ruamel.yaml.comments.CommentedSeq  # defaults to block style
 
 
@@ -135,6 +137,13 @@ def yaml_pipelines_generator(
                 except OSError as e:
                     print("loading yaml template failed", e)
 
+            version_split = httomo_version.split(".")
+            major = version_split[0]
+            minor = version_split[1]
+            pipeline_full.yaml_set_start_comment(
+                f"This pipeline is supported by HTTomo ver. {major}.{minor}"
+            )            
+
             if "loaders" in module_name:
                 # should be the first method in the list
                 pipeline_full.yaml_set_comment_before_after_key(