From 64141dd78987d19b5b72330c0c456d76e31d609f Mon Sep 17 00:00:00 2001 From: John Barker Date: Wed, 31 Dec 2014 22:06:15 +0000 Subject: [PATCH 1/3] Correct URL to github so links work when testing locally --- docsite/rst/community.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docsite/rst/community.rst b/docsite/rst/community.rst index 4d2de28ce16..c4c9f52b2ed 100644 --- a/docsite/rst/community.rst +++ b/docsite/rst/community.rst @@ -66,7 +66,7 @@ Bugs related to the core language should be reported to `github.com/ansible/ansi signing up for a free github account. Before reporting a bug, please use the bug/issue search to see if the issue has already been reported. -MODULE related bugs however should go to `ansible-modules-core `_ or `ansible-modules-extras `_ based on the classification of the module. This is listed on the bottom of the docs page for any module. +MODULE related bugs however should go to `ansible-modules-core `_ or `ansible-modules-extras `_ based on the classification of the module. This is listed on the bottom of the docs page for any module. When filing a bug, please use the `issue template `_ to provide all relevant information, regardless of what repo you are filing a ticket against. From 54f1eebde855d5ee14b97d0cd91ed1b3b54fe49a Mon Sep 17 00:00:00 2001 From: John Barker Date: Thu, 1 Jan 2015 14:13:59 +0000 Subject: [PATCH 2/3] Strip formatting from lists of modules --- hacking/module_formatter.py | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/hacking/module_formatter.py b/hacking/module_formatter.py index 0a7d1c884ca..26e403e8659 100755 --- a/hacking/module_formatter.py +++ b/hacking/module_formatter.py @@ -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): From 64e61197f970f1602243f84cbfe9da2761b46a7c Mon Sep 17 00:00:00 2001 From: John Barker Date: Mon, 5 Jan 2015 20:57:05 +0000 Subject: [PATCH 3/3] Revert accidental changes --- hacking/module_formatter.py | 21 +-------------------- 1 file changed, 1 insertion(+), 20 deletions(-) diff --git a/hacking/module_formatter.py b/hacking/module_formatter.py index 26e403e8659..0a7d1c884ca 100755 --- a/hacking/module_formatter.py +++ b/hacking/module_formatter.py @@ -88,24 +88,6 @@ 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 - ##################################################################################### @@ -328,8 +310,7 @@ 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": - # 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)) + category_file.write(" %s - %s <%s_module>\n" % (modstring, result, module)) def process_category(category, categories, options, env, template, outputname):