Skip to content

Commit

Permalink
Changed documentation template.
Browse files Browse the repository at this point in the history
  • Loading branch information
@trippsc2
trippsc2 committed Jun 20, 2024
1 parent 5531608 commit 8fad5db
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions roles/debian/.aar_doc.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ output_template: |
|Option|Description|Type|Required|Choices|Default|
|---|---|---|---|---|---|
{%- for name, details in options.items() %}
| {{ name }} | {{ details.display_description }} | {{ details.display_type }} | {{ details.display_required }} | {% if ("choices" in details) %}<ul>{% for choice in details.choices %}<li>{{ choice }}</li>{% endfor %}</ul>{% endif %} | {{ details.display_default }} |
| {{ name }} | {% for description_line in details.description %}<p>{{ description_line }}</p>{% endfor %} | {{ details.display_type }} | {{ details.display_required }} | {% if ("choices" in details) %}<ul>{% for choice in details.choices %}<li>{{ choice }}</li>{% endfor %}</ul>{% endif %} | {{ details.display_default }} |
{%- endfor %}
{% if entrypoint_options[entrypoint] | length > 1 -%}
Expand All @@ -57,7 +57,7 @@ output_template: |
|Option|Description|Type|Required|Choices|Default|
|---|---|---|---|---|---|
{%- for name, details in options.items() %}
| {{ name }} | {{ details.display_description }} | {{ details.display_type }} | {{ details.display_required }} | {% if ("choices" in details) %}<ul>{% for choice in details.choices %}<li>{{ choice }}</li>{% endfor %}</ul>{% endif %} | {{ details.display_default }} |
| {{ name }} | {% for description_line in details.description %}<p>{{ description_line }}</p>{% endfor %} | {{ details.display_type }} | {{ details.display_required }} | {% if ("choices" in details) %}<ul>{% for choice in details.choices %}<li>{{ choice }}</li>{% endfor %}</ul>{% endif %} | {{ details.display_default }} |
{%- endfor %}
{% endfor -%}
Expand Down
2 changes: 1 addition & 1 deletion roles/debian/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This role performs first steps on a freshly installed Debian system.
## Role Arguments
|Option|Description|Type|Required|Choices|Default|
|---|---|---|---|---|---|
| debian_is_workstation | Whether the system is a workstation and should start a graphical environment. | bool | no | | false |
| debian_is_workstation | <p>Whether the system is a workstation and should start a graphical environment.</p> | bool | no | | false |


## License
Expand Down
4 changes: 2 additions & 2 deletions roles/rhel/.aar_doc.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ output_template: |
|Option|Description|Type|Required|Choices|Default|
|---|---|---|---|---|---|
{%- for name, details in options.items() %}
| {{ name }} | {{ details.display_description }} | {{ details.display_type }} | {{ details.display_required }} | {% if ("choices" in details) %}<ul>{% for choice in details.choices %}<li>{{ choice }}</li>{% endfor %}</ul>{% endif %} | {{ details.display_default }} |
| {{ name }} | {% for description_line in details.description %}<p>{{ description_line }}</p>{% endfor %} | {{ details.display_type }} | {{ details.display_required }} | {% if ("choices" in details) %}<ul>{% for choice in details.choices %}<li>{{ choice }}</li>{% endfor %}</ul>{% endif %} | {{ details.display_default }} |
{%- endfor %}
{% if entrypoint_options[entrypoint] | length > 1 -%}
Expand All @@ -57,7 +57,7 @@ output_template: |
|Option|Description|Type|Required|Choices|Default|
|---|---|---|---|---|---|
{%- for name, details in options.items() %}
| {{ name }} | {{ details.display_description }} | {{ details.display_type }} | {{ details.display_required }} | {% if ("choices" in details) %}<ul>{% for choice in details.choices %}<li>{{ choice }}</li>{% endfor %}</ul>{% endif %} | {{ details.display_default }} |
| {{ name }} | {% for description_line in details.description %}<p>{{ description_line }}</p>{% endfor %} | {{ details.display_type }} | {{ details.display_required }} | {% if ("choices" in details) %}<ul>{% for choice in details.choices %}<li>{{ choice }}</li>{% endfor %}</ul>{% endif %} | {{ details.display_default }} |
{%- endfor %}
{% endfor -%}
Expand Down
14 changes: 7 additions & 7 deletions roles/rhel/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ This role performs first steps on a freshly installed RHEL-based system.
## Role Arguments
|Option|Description|Type|Required|Choices|Default|
|---|---|---|---|---|---|
| rhel_red_hat_username | Red Hat subscription username. Required for RHEL only. | str | no | | |
| rhel_red_hat_password | Red Hat subscription password. Required for RHEL only. | str | no | | |
| rhel_subscription_auto_attach | Auto attach subscription. Required for RHEL only. | bool | no | | false |
| rhel_subscription_syspurpose_usage | System purpose usage. Required for RHEL only. | str | no | | |
| rhel_subscription_syspurpose_service_level_agreement | System purpose service level agreement. Required for RHEL only. | str | no | | |
| rhel_subscription_syspurpose_sync | System purpose sync. Required for RHEL only. | bool | no | | false |
| rhel_subscription_pool | Subscription pool. Required for RHEL only. | str | no | | |
| rhel_red_hat_username | <p>Red Hat subscription username.</p><p>Required for RHEL only.</p> | str | no | | |
| rhel_red_hat_password | <p>Red Hat subscription password.</p><p>Required for RHEL only.</p> | str | no | | |
| rhel_subscription_auto_attach | <p>Auto attach subscription.</p><p>Required for RHEL only.</p> | bool | no | | false |
| rhel_subscription_syspurpose_usage | <p>System purpose usage.</p><p>Required for RHEL only.</p> | str | no | | |
| rhel_subscription_syspurpose_service_level_agreement | <p>System purpose service level agreement.</p><p>Required for RHEL only.</p> | str | no | | |
| rhel_subscription_syspurpose_sync | <p>System purpose sync.</p><p>Required for RHEL only.</p> | bool | no | | false |
| rhel_subscription_pool | <p>Subscription pool.</p><p>Required for RHEL only.</p> | str | no | | |


## License
Expand Down
4 changes: 2 additions & 2 deletions roles/ubuntu/.aar_doc.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ output_template: |
|Option|Description|Type|Required|Choices|Default|
|---|---|---|---|---|---|
{%- for name, details in options.items() %}
| {{ name }} | {{ details.display_description }} | {{ details.display_type }} | {{ details.display_required }} | {% if ("choices" in details) %}<ul>{% for choice in details.choices %}<li>{{ choice }}</li>{% endfor %}</ul>{% endif %} | {{ details.display_default }} |
| {{ name }} | {% for description_line in details.description %}<p>{{ description_line }}</p>{% endfor %} | {{ details.display_type }} | {{ details.display_required }} | {% if ("choices" in details) %}<ul>{% for choice in details.choices %}<li>{{ choice }}</li>{% endfor %}</ul>{% endif %} | {{ details.display_default }} |
{%- endfor %}
{% if entrypoint_options[entrypoint] | length > 1 -%}
Expand All @@ -57,7 +57,7 @@ output_template: |
|Option|Description|Type|Required|Choices|Default|
|---|---|---|---|---|---|
{%- for name, details in options.items() %}
| {{ name }} | {{ details.display_description }} | {{ details.display_type }} | {{ details.display_required }} | {% if ("choices" in details) %}<ul>{% for choice in details.choices %}<li>{{ choice }}</li>{% endfor %}</ul>{% endif %} | {{ details.display_default }} |
| {{ name }} | {% for description_line in details.description %}<p>{{ description_line }}</p>{% endfor %} | {{ details.display_type }} | {{ details.display_required }} | {% if ("choices" in details) %}<ul>{% for choice in details.choices %}<li>{{ choice }}</li>{% endfor %}</ul>{% endif %} | {{ details.display_default }} |
{%- endfor %}
{% endfor -%}
Expand Down
2 changes: 1 addition & 1 deletion roles/ubuntu/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This role performs first steps on a freshly installed Ubuntu system.
## Role Arguments
|Option|Description|Type|Required|Choices|Default|
|---|---|---|---|---|---|
| ubuntu_is_workstation | Whether the system is a workstation and should start a graphical environment. | bool | no | | false |
| ubuntu_is_workstation | <p>Whether the system is a workstation and should start a graphical environment.</p> | bool | no | | false |


## License
Expand Down

0 comments on commit 8fad5db

Please sign in to comment.