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

Strip formatting from lists of modules

Browse source
This commit is contained in:
John Barker 2015-01-01 14:13:59 +00:00
parent 64141dd789
commit 54f1eebde8
1 changed files with 20 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
hacking/module_formatter.py
View file

@ -88,6 +88,24 @@ def html_ify(text):
return t
#####################################################################################
def strip_formatting(text):
''' Strips formatting
In lists of modules, etc, we don't want certain words to be formatted
Also due to a bug in RST, you can not easily nest formatting
#http://docutils.sourceforge.net/FAQ.html#is-nested-inline-markup-possible
'''
t = cgi.escape(text)
t = _ITALIC.sub(r"\1", t)
t = _BOLD.sub(r"\1", t)
t = _MODULE.sub(r"\1", t)
t = _URL.sub(r"\1", t)
t = _CONST.sub(r"\1", t)
return t
#####################################################################################
@ -310,7 +328,8 @@ def print_modules(module, category_file, deprecated, core, options, env, templat
result = process_module(modname, options, env, template, outputname, module_map, aliases)
if result != "SKIPPED":
category_file.write(" %s - %s <%s_module>\n" % (modstring, result, module))
# Some of the module descriptions have formatting in them, this is noisy in lists, so remove it
category_file.write(" %s - %s <%s_module>\n" % (modstring, strip_formatting(result), module))
def process_category(category, categories, options, env, template, outputname):