docs/sphinx/qapi_domain.py

21 from docutils import nodes
35 from sphinx.util.nodes import make_id, make_refnode
58     from docutils.nodes import Element, Node
70     field: nodes.Node,
71 ) -> Tuple[nodes.field_name, nodes.field_body]:
75     assert isinstance(field, nodes.field)
77     assert isinstance(field.children[0], nodes.field_name)
78     assert isinstance(field.children[1], nodes.field_body)
139         document: nodes.document,
143     ) -> Tuple[List[nodes.Node], List[nodes.system_message]]:
147         results: List[nodes.Node] = [node]
150             results.insert(0, nodes.literal("[", "["))
151             results.append(nodes.literal("]", "]"))
154             results.append(nodes.Text(", "))
155             results.append(nodes.emphasis("?", "optional"))
326     def get_signature_prefix(self) -> List[nodes.Node]:
334     def get_signature_suffix(self) -> List[nodes.Node]:
336         ret: List[nodes.Node] = []
382         infopips = nodes.container()
386             source: str, content: Union[str, List[nodes.Node]], classname: str
388             node = nodes.container(source)
390                 node.append(nodes.Text(content))
415                     nodes.emphasis("", "Availability"),
416                     nodes.Text(": "),
417                     nodes.literal(ifcond, ifcond),
425     def _validate_field(self, field: nodes.field) -> None:
482             if isinstance(child, nodes.field_list):
484                     assert isinstance(field, nodes.field)
489     def make_field(self, *args: Any, **kwargs: Any) -> nodes.field:
647             for el in desc_node.children[0].traverse(nodes.Element)
650             target_node = nodes.target(ids=node_ids)
964     ) -> nodes.reference | None:
1018     ) -> List[Tuple[str, nodes.reference]]:
1019         results: List[Tuple[str, nodes.reference]] = []