ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Documentation: show non-string non-iterable defaults for choices (#40212)

Browse source 
* Also marking non-string defaults.

* Adding list filter from #37517 to plugin_formatter.

* Simplifying list test.

* Redistribute imports
This commit is contained in:
Felix Fontein 2018-06-28 04:31:47 +02:00 committed by Alicia Cozine
parent 5024b4e445
commit 0752dc12b7
2 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/bin/plugin_formatter.py
View file

@ -31,6 +31,7 @@ import sys
import warnings
from collections import defaultdict
from distutils.version import LooseVersion
from functools import partial
from pprint import PrettyPrinter
try:
@ -49,6 +50,7 @@ from six import iteritems, string_types
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
@ -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 '''
@ -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':

2
docs/templates/plugin.rst.j2 vendored
View file

@ -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>