net/ynl/ynl-gen-rst.py

51     # This is useful for some fields that are spread across multiple lines
107     lines = []
109     lines.append(rst_paragraph(".. SPDX-License-Identifier: GPL-2.0"))
110     lines.append(rst_paragraph(".. NOTE: This document was auto-generated.\n\n"))
112     return "\n".join(lines)
117     lines = []
119     lines.append(".. toctree::")
120     lines.append(f"   :maxdepth: {maxdepth}\n\n")
122     return "\n".join(lines)
136     lines = []
138         lines.append(rst_bullet(group["name"]))
140     return "\n".join(lines)
145     lines = []
147         lines.append(rst_paragraph(bold(key), level + 1))
148         lines.append(parse_do_attributes(do_dict[key], level + 1) + "\n")
150     return "\n".join(lines)
157     lines = [rst_fields("attributes", rst_list_inline(attrs["attributes"]), level + 1)]
159     return "\n".join(lines)
165     lines = []
168         lines.append(rst_section(operation["name"]))
169         lines.append(rst_paragraph(sanitize(operation["doc"])) + "\n")
175             lines.append(rst_fields(key, operation[key], 0))
178             lines.append(rst_paragraph(":do:", 0))
179             lines.append(parse_do(operation["do"], 0))
181             lines.append(rst_paragraph(":dump:", 0))
182             lines.append(parse_do(operation["dump"], 0))
185         lines.append("\n")
187     return "\n".join(lines)
192     lines = []
196             lines.append(
200             lines.append(rst_list_inline(entry, level))
202             lines.append(rst_bullet(inline(sanitize(entry)), level))
204     lines.append("\n")
205     return "\n".join(lines)
212     lines = []
215         lines.append(rst_section(definition["name"]))
219             lines.append(rst_fields(k, sanitize(definition[k]), 0))
222         lines.append("\n")
224             lines.append(rst_paragraph(":entries:", 0))
225             lines.append(parse_entries(definition["entries"], 1))
227             lines.append(rst_paragraph(":members:", 0))
228             lines.append(parse_entries(definition["members"], 1))
230     return "\n".join(lines)
237     lines = []
240         lines.append(rst_section(entry["name"]))
248             lines.append(rst_subsubsection(attr_line))
253                 lines.append(rst_fields(k, sanitize(attr[k]), 0))
254             lines.append("\n")
256     return "\n".join(lines)
261     lines = []
264         lines.append(rst_section(entry["name"]))
268             lines.append(rst_bullet(bold(value)))
271                     lines.append(rst_fields(attr, fmt[attr], 1))
272             lines.append("\n")
274     return "\n".join(lines)
279     lines = []
283     lines.append(rst_header())
286     lines.append(rst_title(title))
287     lines.append(rst_paragraph(".. contents::\n"))
290         lines.append(rst_subtitle("Summary"))
291         lines.append(rst_paragraph(obj["doc"], 0))
295         lines.append(rst_subtitle("Operations"))
296         lines.append(parse_operations(obj["operations"]["list"]))
300         lines.append(rst_subtitle("Multicast groups"))
301         lines.append(parse_mcast_group(obj["mcast-groups"]["list"]))
305         lines.append(rst_subtitle("Definitions"))
306         lines.append(parse_definitions(obj["definitions"]))
310         lines.append(rst_subtitle("Attribute sets"))
311         lines.append(parse_attr_sets(obj["attribute-sets"]))
315         lines.append(rst_subtitle("Sub-messages"))
316         lines.append(parse_sub_messages(obj["sub-messages"]))
318     return "\n".join(lines)
377     lines = []
379     lines.append(rst_header())
380     lines.append(rst_label("specs"))
381     lines.append(rst_title("Netlink Family Specifications"))
382     lines.append(rst_toctree(1))
389         lines.append(f"   {filename.replace('.rst', '')}\n")
392     write_to_rstfile("".join(lines), output)