From d40382425f3b79bd662949e7259479e568e8698e Mon Sep 17 00:00:00 2001 From: Lorenz Meier Date: Wed, 29 Jan 2014 14:51:57 +0100 Subject: Triggering param documentation generation --- Tools/px4params/dokuwikiout.py | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) (limited to 'Tools/px4params/dokuwikiout.py') diff --git a/Tools/px4params/dokuwikiout.py b/Tools/px4params/dokuwikiout.py index 4d40a6201..c4fadbd35 100644 --- a/Tools/px4params/dokuwikiout.py +++ b/Tools/px4params/dokuwikiout.py @@ -1,10 +1,24 @@ import output +from xml.sax.saxutils import escape class DokuWikiOutput(output.Output): def Generate(self, groups): - result = "" + pre_text = """ + + wiki.putPage + + + + :dev:parameters:reference + + + + + """ + result = "====== Parameter Reference ======\nThis list is auto-generated every few minutes and contains the most recent parameter names and default values." for group in groups: result += "==== %s ====\n\n" % group.GetName() + result += "|< 100% 20% 20% 10% 10% 10% 30%>|\n" result += "^ Name ^ Description ^ Min ^ Max ^ Default ^ Comment ^\n" for param in group.GetParams(): code = param.GetFieldValue("code") @@ -34,4 +48,15 @@ class DokuWikiOutput(output.Output): result += "|" result += "|\n" result += "\n" - return result + post_text = """ + + + + + sum + Updated parameters automagically from code. + + + + """ + return pre_text + escape(result) + post_text -- cgit v1.2.3 From 60859607ff240f1aaad05b306ba86b84d15be2ac Mon Sep 17 00:00:00 2001 From: Lorenz Meier Date: Wed, 29 Jan 2014 15:11:50 +0100 Subject: Better output --- Tools/px4params/dokuwikiout.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'Tools/px4params/dokuwikiout.py') diff --git a/Tools/px4params/dokuwikiout.py b/Tools/px4params/dokuwikiout.py index c4fadbd35..42da19e8b 100644 --- a/Tools/px4params/dokuwikiout.py +++ b/Tools/px4params/dokuwikiout.py @@ -27,26 +27,26 @@ class DokuWikiOutput(output.Output): result += "| %s | %s " % (code, name) min_val = param.GetFieldValue("min") if min_val is not None: - result += "| %s " % min_val + result += " | %s " % min_val else: - result += "|" + result += " | " max_val = param.GetFieldValue("max") if max_val is not None: - result += "| %s " % max_val + result += " | %s " % max_val else: - result += "|" + result += " | " def_val = param.GetFieldValue("default") if def_val is not None: result += "| %s " % def_val else: - result += "|" + result += " | " long_desc = param.GetFieldValue("long_desc") if long_desc is not None: long_desc = long_desc.replace("\n", "") result += "| %s " % long_desc else: - result += "|" - result += "|\n" + result += " | " + result += " |\n" result += "\n" post_text = """ -- cgit v1.2.3 From 2b17909f0c4131f6a728697f5de1eb13a1337234 Mon Sep 17 00:00:00 2001 From: Lorenz Meier Date: Wed, 29 Jan 2014 19:18:44 +0100 Subject: Changed param location --- Tools/px4params/dokuwikiout.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Tools/px4params/dokuwikiout.py') diff --git a/Tools/px4params/dokuwikiout.py b/Tools/px4params/dokuwikiout.py index 42da19e8b..c5cf65ea6 100644 --- a/Tools/px4params/dokuwikiout.py +++ b/Tools/px4params/dokuwikiout.py @@ -9,7 +9,7 @@ class DokuWikiOutput(output.Output): - :dev:parameters:reference + :firmware:parameters -- cgit v1.2.3