mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-04-16 05:41:04 +00:00
Improve parameter required values and ref fix (#36680)
This PR includes: - An improvement to the parameter listing, where instead of yes/no, it is indicated with required/optional (easier when scrolling through a long list of parameters) - Ensure that module reference, eg. M(foobar) do not include the module document title
This commit is contained in:
@@ -89,7 +89,7 @@ def rst_ify(text):
|
||||
try:
|
||||
t = _ITALIC.sub(r"*\1*", text)
|
||||
t = _BOLD.sub(r"**\1**", t)
|
||||
t = _MODULE.sub(r":ref:`\1`", t)
|
||||
t = _MODULE.sub(r":ref:`\1 <\1>`", t)
|
||||
t = _URL.sub(r"\1", t)
|
||||
t = _CONST.sub(r"`\1`", t)
|
||||
except Exception as e:
|
||||
|
||||
2
docs/templates/plugin.rst.j2
vendored
2
docs/templates/plugin.rst.j2
vendored
@@ -115,7 +115,7 @@ Options
|
||||
<div class="outer-elbow-container">
|
||||
</td>
|
||||
{# required #}
|
||||
<td><div class="cell-border">{% if value.get('required', False) %}yes{% else %}no{% endif %}</div></td>
|
||||
<td><div class="cell-border">{% if value.get('required', False) %}required{% else %}optional{% endif %}</div></td>
|
||||
{# default value #}
|
||||
<td><div class="cell-border">{% if value.default %}@{ value.default }@{% endif %}</div></td>
|
||||
{# choices #}
|
||||
|
||||
Reference in New Issue
Block a user