net/ynl/ynl-gen-rst.py

118     lines = []
120     lines.append(rst_paragraph(".. SPDX-License-Identifier: GPL-2.0"))
121     lines.append(rst_paragraph(".. NOTE: This document was auto-generated.\n\n"))
123     return "\n".join(lines)
128     lines = []
130     lines.append(".. toctree::")
131     lines.append(f"   :maxdepth: {maxdepth}\n\n")
133     return "\n".join(lines)
147     lines = []
149         lines.append(rst_bullet(group["name"]))
151     return "\n".join(lines)
156     lines = []
158         lines.append(rst_paragraph(bold(key), level + 1))
160             lines.append(parse_do_attributes(do_dict[key], level + 1) + "\n")
162             lines.append(headroom(level + 2) + do_dict[key] + "\n")
164     return "\n".join(lines)
171     lines = [rst_fields("attributes", rst_list_inline(attrs["attributes"]), level + 1)]
173     return "\n".join(lines)
180     lines = []
183         lines.append(rst_section(namespace, 'operation', operation["name"]))
184         lines.append(rst_paragraph(operation["doc"]) + "\n")
193             lines.append(rst_fields(key, value, 0))
195             lines.append(rst_fields('flags', rst_list_inline(operation['flags'])))
198             lines.append(rst_paragraph(":do:", 0))
199             lines.append(parse_do(operation["do"], 0))
201             lines.append(rst_paragraph(":dump:", 0))
202             lines.append(parse_do(operation["dump"], 0))
205         lines.append("\n")
207     return "\n".join(lines)
213     lines = []
223             lines.append(
227             lines.append(rst_list_inline(entry, level))
229             lines.append(rst_bullet(inline(sanitize(entry)), level))
231     lines.append("\n")
232     return "\n".join(lines)
239     lines = []
242         lines.append(rst_section(namespace, 'definition', definition["name"]))
246             lines.append(rst_fields(k, sanitize(definition[k]), 0))
249         lines.append("\n")
251             lines.append(rst_paragraph(":entries:", 0))
252             lines.append(parse_entries(definition["entries"], 1))
254             lines.append(rst_paragraph(":members:", 0))
255             lines.append(parse_entries(definition["members"], 1))
257     return "\n".join(lines)
265     lines = []
268         lines.append(rst_section(namespace, 'attribute-set', entry["name"]))
276             lines.append(rst_subsubsection(attr_line))
285                 lines.append(rst_fields(k, value, 0))
286             lines.append("\n")
288     return "\n".join(lines)
293     lines = []
296         lines.append(rst_section(namespace, 'sub-message', entry["name"]))
300             lines.append(rst_bullet(bold(value)))
303                     lines.append(rst_fields(attr,
306             lines.append("\n")
308     return "\n".join(lines)
313     lines = []
317     lines.append(rst_header())
322     lines.append(rst_title(title))
323     lines.append(rst_paragraph(".. contents:: :depth: 3\n"))
326         lines.append(rst_subtitle("Summary"))
327         lines.append(rst_paragraph(obj["doc"], 0))
331         lines.append(rst_subtitle("Operations"))
332         lines.append(parse_operations(obj["operations"]["list"], family))
336         lines.append(rst_subtitle("Multicast groups"))
337         lines.append(parse_mcast_group(obj["mcast-groups"]["list"]))
341         lines.append(rst_subtitle("Definitions"))
342         lines.append(parse_definitions(obj["definitions"], family))
346         lines.append(rst_subtitle("Attribute sets"))
347         lines.append(parse_attr_sets(obj["attribute-sets"], family))
351         lines.append(rst_subtitle("Sub-messages"))
352         lines.append(parse_sub_messages(obj["sub-messages"], family))
354     return "\n".join(lines)
413     lines = []
415     lines.append(rst_header())
416     lines.append(rst_label("specs"))
417     lines.append(rst_title("Netlink Family Specifications"))
418     lines.append(rst_toctree(1))
425         lines.append(f"   {filename.replace('.rst', '')}\n")
428     write_to_rstfile("".join(lines), output)