Skip to content

Commit

Permalink
Documentation: show non-string non-iterable defaults for choices (ans…
Browse files Browse the repository at this point in the history
…ible#40212)

* Also marking non-string defaults.

* Adding list filter from ansible#37517 to plugin_formatter.

* Simplifying list test.

* Redistribute imports
  • Loading branch information
felixfontein authored and Alicia Cozine committed Jun 28, 2018
1 parent 5024b4e commit 0752dc1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/bin/plugin_formatter.py
Expand Up @@ -31,6 +31,7 @@
import warnings
from collections import defaultdict
from distutils.version import LooseVersion
from functools import partial
from pprint import PrettyPrinter

try:
Expand All @@ -49,6 +50,7 @@ def html_escape(text, quote=True):

from ansible.errors import AnsibleError
from ansible.module_utils._text import to_bytes, to_text
from ansible.module_utils.common.collections import is_sequence
from ansible.plugins.loader import fragment_loader
from ansible.utils import plugin_docs
from ansible.utils.display import Display
Expand Down Expand Up @@ -154,6 +156,9 @@ def rst_xline(width, char="="):
return char * width


test_list = partial(is_sequence, include_strings=False)


def write_data(text, output_dir, outputname, module=None):
''' dumps module output to a file or the screen, as requested '''

Expand Down Expand Up @@ -334,6 +339,7 @@ def jinja2_environment(template_dir, typ, plugin_type):
env.filters['html_ify'] = html_ify
env.filters['fmt'] = rst_fmt
env.filters['xline'] = rst_xline
env.tests['list'] = test_list
templates['plugin'] = env.get_template('plugin.rst.j2')

if plugin_type == 'module':
Expand Down
2 changes: 1 addition & 1 deletion docs/templates/plugin.rst.j2
Expand Up @@ -142,7 +142,7 @@ Parameters
{% elif choice is sameas false %}
{% set choice = 'no' %}
{% endif %}
{% if (value.default is string and value.default == choice) or (value.default is iterable and value.default is not string and choice in value.default) %}
{% if (value.default is not list and value.default == choice) or (value.default is list and choice in value.default) %}
<li><div style="color: blue"><b>@{ choice | escape }@</b>&nbsp;&larr;</div></li>
{% else %}
<li>@{ choice | escape }@</li>
Expand Down

0 comments on commit 0752dc1

Please sign in to comment.