fly316/PX4-Autopilot
7
0
Fork 0
mirror of https://gitee.com/mirrors_PX4/PX4-Autopilot.git synced 2026-04-14 10:07:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Parameter markdown use page css for layout

Browse Source
This commit is contained in:
Hamish Willee 2021-01-20 20:15:26 -08:00 committed by Beat Küng
parent 9a066959d4
commit bd00aec936
1 changed files with 32 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
src/lib/parameters/px4params/markdownout.py
View File

@ -3,21 +3,39 @@ import codecs
class MarkdownTablesOutput():
def __init__(self, groups):
result = ("# Parameter Reference\n"
"> **Note** **This documentation was auto-generated from the source code for this PX4 version** (using `make parameters_metadata`).\n"
"\n"
"<span></span>\n"
"> **Note** If a listed parameter is missing from the Firmware see: [Finding/Updating Parameters](http://docs.px4.io/master/en/advanced_config/parameters.html#missing).\n"
"\n")
result = (
"""# Parameter Reference
:::note
This documentation was auto-generated from the source code for this PX4 version (using `make parameters_metadata`).
:::
:::tip
If a listed parameter is missing from the Firmware see: [Finding/Updating Parameters](http://docs.px4.io/master/en/advanced_config/parameters.html#missing).
:::
<!-- markdown generator: src/lib/parameters/px4params/markdownout.py -->
<style>
tr > * {
vertical-align : top;
}
</style>
"""
)
for group in groups:
result += '## %s\n\n' % group.GetName()
result += '<table>\n'
result += ' <colgroup><col style="width: 23%"><col style="width: 46%"><col style="width: 11%"><col style="width: 11%"><col style="width: 9%"></colgroup>\n'
result += ' <thead>\n'
result += ' <tr><th>Name</th><th>Description</th><th>Min > Max (Incr.)</th><th>Default</th><th>Units</th></tr>\n'
result += ' </thead>\n'
result += '<tbody>\n'
result += (
"""<table>
<colgroup><col style="width: 23%"><col style="width: 46%"><col style="width: 11%"><col style="width: 11%"><col style="width: 9%"></colgroup>
<thead>
<tr><th>Name</th><th>Description</th><th>Min > Max (Incr.)</th><th>Default</th><th>Units</th></tr>
</thead>
<tbody>
"""
)
for param in group.GetParams():
code = param.GetName()
name = param.GetFieldValue("short_desc") or ''
@ -84,7 +102,7 @@ class MarkdownTablesOutput():
if is_boolean and def_val=='0':
def_val='Disabled (0)'
result += '<tr>\n <td style="vertical-align: top;">%s (%s)</td>\n <td style="vertical-align: top;"><p>%s</p>%s %s %s %s</td>\n <td style="vertical-align: top;">%s</td>\n <td style="vertical-align: top;">%s</td>\n <td style="vertical-align: top;">%s</td>\n</tr>\n' % (code, type, name, long_desc, enum_output, bitmask_output, reboot_required, max_min_combined, def_val, unit)
result += '<tr>\n <td>%s (%s)</td>\n <td>%s %s %s %s %s</td>\n <td>%s</td>\n <td>%s</td>\n <td>%s</td>\n</tr>\n' % (code, type, name, long_desc, enum_output, bitmask_output, reboot_required, max_min_combined, def_val, unit)
#Close the table.
result += '</tbody></table>\n\n'