docs/sphinx/qapi_domain.py

126             # Explicit title syntax for references is e.g.
166     TOC, and reference targets for QAPI descriptions.
173         # being documented; for QAPI, this is the same as the
182         """Return the text for the index entry of the object."""
184         # NB: this is used for the global index, not the QAPI index.
218         # For QAPI, these are identical, currently.
352         This method was originally intended for handling function
466                 f"Valid fields for qapi:{self.objtype} are: {valid}\n"
481         for child in content_node:
483                 for field in child.children:
492         # Look for the characteristic " -- " text node that Sphinx
493         # inserts for each TypedField entry ...
494         for node in ret.traverse(lambda n: str(n) == " -- "):
575     """Base class for Events/Structs/Unions"""
607     a pass-through for the content body. Named section titles are
610     Use this directive to create entries for the QAPI module in the
612     definitions with the module they are defined in for purposes of
647             for el in desc_node.children[0].traverse(nodes.Element)
648             for node_id in cast(List[str], el.get("ids", ()))
687         for objname, obj in self.domain.objects.items():
712         for category in content:
731     # for each object type.
790         for namespace in namespaces:
811         """Note a QAPI object for cross reference."""
825                         "other instance in %s, use :no-index: for one of them"
836         for fullname, obj in list(self.objects.items()):
843         for fullname, obj in otherdata["objects"].items():
846                 # check for collisions. Assert they don't happen and
858         Find a QAPI object for "name", maybe using contextual information.
869             provided. This is absent for "any" role lookups.
875         # what to search for
879         explicit = tuple(bool(x) for x in parts)
923             esc = tuple(re.escape(s) for s in parts)
925             # Try searching for ns:*.name or ns:name
928             # Try searching for *:module.name or module.name
931             # Try searching for context-ns:*.name or context-ns:name
934             # Try searching for *:context-mod.name or context-mod.name
937             # Try searching for *:name, *.name, or name
941             for search in searches:
944                     for oname in self.objects
950         matches = [(oname, self.objects[oname]) for oname in found]
952             matches = [m for m in matches if not m[1].aliased]
997                 __("more than one target found for cross-reference %r: %s"),
999                 ", ".join(match[0] for match in matches),
1023         for name, obj in matches: