From 2de010fd38665ec8d04017f4a43b79e1736d1720 Mon Sep 17 00:00:00 2001 From: AnsMelanie Date: Fri, 8 Aug 2025 15:47:07 +0200 Subject: [PATCH 1/2] upd templates for operator doc --- .../operator_doc_template.md | 7 ++--- .../operator-specifications/toc_template.j2 | 30 ++++++++++++++----- 2 files changed, 25 insertions(+), 12 deletions(-) diff --git a/doc/source/operators_doc/operator-specifications/operator_doc_template.md b/doc/source/operators_doc/operator-specifications/operator_doc_template.md index 12495e7447..c040f34683 100644 --- a/doc/source/operators_doc/operator-specifications/operator_doc_template.md +++ b/doc/source/operators_doc/operator-specifications/operator_doc_template.md @@ -18,8 +18,7 @@ license: {{ scripting_info.license }} |-------|-------|------------------|-------------| {%- for input in inputs %} | {% if not input.optional %}Pin {{ input.pin_number }}
Required{% else %}Pin {{ input.pin_number }}{% endif %}| {{ input.name }} | -{%- for t in input.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap" or t == "stream" or t == "vector>" or t == "vector>" or t == "umap>" or t == "vector>" or t == "vector>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "mesh_selection_manager" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" - %}{{ t }}{% elif t == "int32" or t == "bool" or t == char or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ input.document | replace("\n", "
") }} | +{%- for t in input.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap" or t == "stream" or t == "vector>" or t == "vector>" or t == "umap>" or t == "vector>" or t == "vector>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "mesh_selection_manager" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" %}`{{ t }}`{% elif t == "int32" or t == "bool" or t == "char" or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ input.document | replace("\n", "
") }} | {%- endfor %} ## Outputs @@ -28,7 +27,7 @@ license: {{ scripting_info.license }} |-------|------|------------------|-------------| {%- for output in outputs %} | **Pin {{ output.pin_number }}**| {{ output.name }} | -{%- for t in output.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap" or t == "stream" or t == "vector>" or t == "vector>" or t == "umap>" or t == "vector>" or t == "vector>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "mesh_selection_manager" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" %}{{ t }}{% elif t == "int32" or t == "bool" or t == char or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ output.document }} | +{%- for t in output.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap" or t == "stream" or t == "vector>" or t == "vector>" or t == "umap>" or t == "vector>" or t == "vector>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "mesh_selection_manager" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" %}`{{ t }}`{% elif t == "int32" or t == "bool" or t == "char" or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ output.document }} | {%- endfor %} ## Configurations @@ -37,7 +36,7 @@ license: {{ scripting_info.license }} |-----|------|----------|-------------| {%- for configuration in configurations %} | **{{ configuration.name }}** | -{%- for t in configuration.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap" or t == "stream" or t == "vector>" or t == "vector>" or t == "umap>" or t == "vector>" or t == "vector>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "mesh_selection_manager" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" %}{{ t }}{% elif t == "int32" or t == "bool" or t == char or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ configuration.default_value }} | {{ configuration.document }} | +{%- for t in configuration.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap" or t == "stream" or t == "vector>" or t == "vector>" or t == "umap>" or t == "vector>" or t == "vector>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "mesh_selection_manager" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" %}`{{ t }}`{% elif t == "int32" or t == "bool" or t == "char" or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ configuration.default_value }} | {{ configuration.document }} | {%- endfor %} ## Scripting diff --git a/doc/source/operators_doc/operator-specifications/toc_template.j2 b/doc/source/operators_doc/operator-specifications/toc_template.j2 index eb6a58649c..20345c1fba 100644 --- a/doc/source/operators_doc/operator-specifications/toc_template.j2 +++ b/doc/source/operators_doc/operator-specifications/toc_template.j2 @@ -2,23 +2,37 @@ href: index.md - name: Getting started items: - - name: Using data containers - href: getting-started/using-data-containers.md - - name: Using operators - href: getting-started/using-operators.md - - name: Workflow examples - href: getting-started/workflow-examples.md + - name: Installation + href: getting-started/installation.md + - name: Licensing + href: getting-started/licensing.md + - name: Configuration + href: getting-started/configuration.md +- name: User guide + items: + - name: The server context + href: user-guide/server-context.md + - name: How to use data containers + href: user-guide/using-data-containers.md + - name: How to use operators + href: user-guide/using-operators.md + - name: Workflow examples for beginners + href: user-guide/workflow-examples.md - name: Core concepts items: - name: Available types href: core-concepts/dpf-types.md - - name: Operator + - name: Operator fundamentals href: core-concepts/operator.md - name: Operator specifications items: + - name: Operator specifications + href: operator-specifications/operator-specifications.md {% for category in data -%} - name: {{ category.category }} items:{% for operator in category.operators %} - name: {{ operator.operator_name }} href: operator-specifications/{{ operator.file_path }}{% endfor %} - {% endfor %} \ No newline at end of file + {% endfor %} +- name: Changelog + href: changelog/changelog-25-r2.md \ No newline at end of file From 51bdc84a595b385667a7c428e76091811e62aadc Mon Sep 17 00:00:00 2001 From: AnsMelanie Date: Fri, 8 Aug 2025 16:47:10 +0200 Subject: [PATCH 2/2] Corrected templates for operator doc --- .../operator-specifications/operator_doc_template.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/source/operators_doc/operator-specifications/operator_doc_template.md b/doc/source/operators_doc/operator-specifications/operator_doc_template.md index c040f34683..3476628f85 100644 --- a/doc/source/operators_doc/operator-specifications/operator_doc_template.md +++ b/doc/source/operators_doc/operator-specifications/operator_doc_template.md @@ -18,7 +18,7 @@ license: {{ scripting_info.license }} |-------|-------|------------------|-------------| {%- for input in inputs %} | {% if not input.optional %}Pin {{ input.pin_number }}
Required{% else %}Pin {{ input.pin_number }}{% endif %}| {{ input.name }} | -{%- for t in input.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap" or t == "stream" or t == "vector>" or t == "vector>" or t == "umap>" or t == "vector>" or t == "vector>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "mesh_selection_manager" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" %}`{{ t }}`{% elif t == "int32" or t == "bool" or t == "char" or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ input.document | replace("\n", "
") }} | +{%- for t in input.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap" or t == "stream" or t == "vector>" or t == "vector>" or t == "umap>" or t == "vector>" or t == "vector>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "mesh_selection_manager" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" %}`{{ t }}`{% elif t == "int32" or t == "bool" or t == "char" or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ input.document | replace("\n", "
") }} | {%- endfor %} ## Outputs @@ -27,7 +27,7 @@ license: {{ scripting_info.license }} |-------|------|------------------|-------------| {%- for output in outputs %} | **Pin {{ output.pin_number }}**| {{ output.name }} | -{%- for t in output.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap" or t == "stream" or t == "vector>" or t == "vector>" or t == "umap>" or t == "vector>" or t == "vector>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "mesh_selection_manager" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" %}`{{ t }}`{% elif t == "int32" or t == "bool" or t == "char" or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ output.document }} | +{%- for t in output.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap" or t == "stream" or t == "vector>" or t == "vector>" or t == "umap>" or t == "vector>" or t == "vector>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "mesh_selection_manager" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" %}`{{ t }}`{% elif t == "int32" or t == "bool" or t == "char" or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ output.document }} | {%- endfor %} ## Configurations @@ -36,7 +36,7 @@ license: {{ scripting_info.license }} |-----|------|----------|-------------| {%- for configuration in configurations %} | **{{ configuration.name }}** | -{%- for t in configuration.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap" or t == "stream" or t == "vector>" or t == "vector>" or t == "umap>" or t == "vector>" or t == "vector>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "mesh_selection_manager" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" %}`{{ t }}`{% elif t == "int32" or t == "bool" or t == "char" or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ configuration.default_value }} | {{ configuration.document }} | +{%- for t in configuration.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap" or t == "stream" or t == "vector>" or t == "vector>" or t == "umap>" or t == "vector>" or t == "vector>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "mesh_selection_manager" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" or t == "vector>" %}`{{ t }}`{% elif t == "int32" or t == "bool" or t == "char" or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" or t == "vector" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ configuration.default_value }} | {{ configuration.document }} | {%- endfor %} ## Scripting