From 5a3028447fecfd715babffd3f1deb3cbce9b8a72 Mon Sep 17 00:00:00 2001 From: madanucd Date: Mon, 17 Jun 2024 17:22:44 -0400 Subject: [PATCH] doc_template file --- src/doc_templates/common_metadata.md.jinja2 | 78 +++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 src/doc_templates/common_metadata.md.jinja2 diff --git a/src/doc_templates/common_metadata.md.jinja2 b/src/doc_templates/common_metadata.md.jinja2 new file mode 100644 index 0000000..de147a5 --- /dev/null +++ b/src/doc_templates/common_metadata.md.jinja2 @@ -0,0 +1,78 @@ +{% if element.aliases %} +## Aliases + +{% for alias in element.aliases %} +* {{ alias }} +{%- endfor %} +{% endif %} + + +{% if element.examples %} +## Examples + +| Value | +| --- | +{% for x in element.examples -%} +| {{ x.value }} | +{% endfor %} +{% endif -%} + +{% if element.comments -%} +## Comments + +{% for x in element.comments -%} +* {{x}} +{% endfor %} +{% endif -%} + +{% if element.todos -%} +## TODOs + +{% for x in element.todos -%} +* {{x}} +{% endfor %} +{% endif -%} + +{% if element.see_also -%} +## See Also + +{% for x in element.see_also -%} +* {{ gen.uri_link(x) }} +{% endfor %} +{% endif -%} + +## Identifier and Mapping Information + +{% if element.id_prefixes %} +### Valid ID Prefixes + +Instances of this class *should* have identifiers with one of the following prefixes: +{% for p in element.id_prefixes %} +* {{p}} +{% endfor %} + +{% endif %} + + +{% if element.annotations %} +### Annotations + +| property | value | +| --- | --- | +{% for a in element.annotations -%} +{%- if a|string|first != '_' -%} +| {{ a }} | {{ element.annotations[a].value }} | +{%- endif -%} +{% endfor %} +{% endif %} + +{% if element.from_schema or element.imported_from %} +### Schema Source + +{% if element.from_schema %} +* from schema: {{ element.from_schema }} +{% endif %} +{% if element.imported_from %} +* imported from: {{ element.imported_from }} +{% endif %} +{% endif %} \ No newline at end of file