fix(ci): patch aar-doc markdown template

This commit is contained in:
s3lph 2025-03-01 00:12:04 +01:00
parent 0101ac7aa6
commit 91d7869fcc
Signed by: s3lph
GPG key ID: 0AA29A52FB33CFB5
2 changed files with 35 additions and 6 deletions
.forgejo/workflows
roles/knot

View file

@ -70,7 +70,41 @@ jobs:
commented_defaults[role_default.name] = value
description_items = (
role_default.description
EOF
--- a/aar_doc/templates/markdown.j2
+++ b/aar_doc/templates/markdown.j2
@@ -29,17 +29,17 @@ Tags: {{ metadata.galaxy_info.galaxy_tags | join(', ') }}
{{ argument_specs[entrypoint].description }}
{% else %}
{%- for line in argument_specs[entrypoint].description -%}
-{{ line }}
-{% endfor -%}
-{% endif -%}
-{% endif -%}
+{{ line }}
+{% endfor %}
+{% endif %}
+{% endif %}
{% if entrypoint_options[entrypoint] %}
{%- set path, options=entrypoint_options[entrypoint][0] -%}
|Option|Description|Type|Required|Default|
|---|---|---|---|---|
{%- for name, details in options.items() %}
-| {{ name }} | {{ details.display_description }} | {{ details.display_type }} | {{ details.display_required }} | {{ details.display_default }} |
+| `{{ name }}` | {{ details.display_description }} | {{ details.display_type }} | {{ details.display_required }} | `{{ details.display_default }}` |
{%- endfor %}
{% if entrypoint_options[entrypoint] | length > 1 -%}
@@ -49,7 +49,7 @@ Tags: {{ metadata.galaxy_info.galaxy_tags | join(', ') }}
|Option|Description|Type|Required|Default|
|---|---|---|---|---|
{%- for name, details in options.items() %}
-| {{ name }} | {{ details.display_description }} | {{ details.display_type }} | {{ details.display_required }} | {{ details.display_default }} |
+| `{{ name }}` | {{ details.display_description }} | {{ details.display_type }} | {{ details.display_required }} | `{{ details.display_default }}` |
{%- endfor %}
{% endfor -%}
EOF
- name: Set version in galaxy.yml
run: |

View file

@ -1,5 +0,0 @@
# Role s3lph.nameserver.knot
Documentation in `meta/argument_specs.yml`.
A usage example can be found in the `docs` folder of the collection.