ReST template (PickNikRobotics#119)

Author: christophfroehlich

generate_parameter_library_py/generate_parameter_library_py/generate_markdown.py

@@ -159,9 +159,9 @@ def __str__(self):
         return code
 
 
-def run(yaml_file, output_file):
+def run(yaml_file, output_file, language):
     # cpp is used here because it the desired style of the markdown, e.g. false for C++ instead of False for Python
-    gen_param_struct = GenerateCode("cpp")
+    gen_param_struct = GenerateCode(language)
     output_dir = os.path.dirname(output_file)
     if output_dir and not os.path.isdir(output_dir):
         os.makedirs(output_dir)
@@ -180,8 +180,9 @@ def main():
     parser = argparse.ArgumentParser()
     parser.add_argument("--output_markdown_file")
     parser.add_argument("--input_yaml_file")
+    parser.add_argument("--language", default="markdown")
     args = parser.parse_args()
-    run(args.input_yaml_file, args.output_markdown_file)
+    run(args.input_yaml_file, args.output_markdown_file, args.language)
     print(args)
 
 

generate_parameter_library_py/generate_parameter_library_py/jinja_templates/rst/default_config

@@ -0,0 +1,9 @@
+.. code::
+{%- filter indent(width=2) %}
+
+{{namespace}}:
+  ros__parameters:
+{%- filter indent(width=4) %}
+{{default_param_values}}
+{% endfilter -%}
+{% endfilter -%}

generate_parameter_library_py/generate_parameter_library_py/jinja_templates/rst/documentation

@@ -0,0 +1,6 @@
+{{title}} Parameters
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+{{default_config}}
+
+{{parameter_details}}

generate_parameter_library_py/generate_parameter_library_py/jinja_templates/rst/parameter_detail

@@ -0,0 +1,16 @@
+{{name}} ({{type}}){% if description|length %}
+  {{description}}
+{% endif %}
+{%- if default_value|length %}
+  Default:  {{default_value}}
+{% endif %}
+{%- if constraints|length %}
+
+  Constraints:
+
+{%- filter indent(width=2) %}
+
+{{constraints}}
+{% endfilter -%}
+
+{% endif %}

generate_parameter_library_py/generate_parameter_library_py/parse_yaml.py

@@ -151,6 +151,10 @@ def __init__(
     ):
         if language == "cpp":
             self.conversation = CPPConverstions()
+        elif language == "rst" or language == "markdown":
+            # cpp is used here because it the desired style of the markdown,
+            # e.g. "false" for C++ instead of "False" for Python
+            self.conversation = CPPConverstions()
         elif language == "python":
             self.conversation = PythonConvertions()
         else:
@@ -603,10 +607,19 @@ def get_all_templates(language: str):
     template_lang_path = os.path.join(
         os.path.dirname(__file__), "jinja_templates", language
     )
-    template_markdown_path = os.path.join(
-        os.path.dirname(__file__), "jinja_templates", "markdown"
-    )
-    template_paths = [template_lang_path, template_markdown_path]
+    if language == "markdown":
+        template_markdown_path = os.path.join(
+            os.path.dirname(__file__), "jinja_templates", "markdown"
+        )
+        template_paths = [template_lang_path, template_markdown_path]
+    elif language == "rst":
+        template_rst_path = os.path.join(
+            os.path.dirname(__file__), "jinja_templates", "rst"
+        )
+        template_paths = [template_lang_path, template_rst_path]
+    else:
+        template_paths = [template_lang_path]
+
     template_map = {}
     for template_path in template_paths:
         for file_name in [
@@ -691,7 +704,9 @@ def __init__(self, language: str):
         self.set_stack_params = []
         if language == "cpp":
             self.comments = "// auto-generated DO NOT EDIT"
-        elif language == "python":
+        elif language == "rst":
+            self.comments = ".. auto-generated DO NOT EDIT"
+        elif language == "python" or language == "markdown":
             self.comments = "# auto-generated DO NOT EDIT"
         else:
             raise compile_error(

generate_parameter_library_py/setup.py

@@ -54,6 +54,9 @@
             "jinja_templates/markdown/default_config",
             "jinja_templates/markdown/documentation",
             "jinja_templates/markdown/parameter_detail",
+            "jinja_templates/rst/default_config",
+            "jinja_templates/rst/documentation",
+            "jinja_templates/rst/parameter_detail",
             "jinja_templates/python/declare_parameter",
             "jinja_templates/python/declare_runtime_parameter",
             "jinja_templates/python/declare_struct",