Adds the .. qapi:struct:: directive, object, and :qapi:struct:`name` cross-referencing role.
As per usual, QAPI cross-referencing for types in the member field list will be added in a forthcoming commit. Signed-off-by: John Snow <js...@redhat.com> --- docs/sphinx/qapi-domain.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/sphinx/qapi-domain.py b/docs/sphinx/qapi-domain.py index e042421016f..d94d84bc186 100644 --- a/docs/sphinx/qapi-domain.py +++ b/docs/sphinx/qapi-domain.py @@ -344,6 +344,12 @@ class QAPIEvent(QAPIObjectWithMembers): pass +class QAPIStruct(QAPIObjectWithMembers): + """Description of a QAPI Struct.""" + + pass + + class QAPIModule(SphinxDirective): """ Directive to mark description of a new module. @@ -506,6 +512,7 @@ class QAPIDomain(Domain): "command": ObjType(_("command"), "cmd", "obj"), "event": ObjType(_("event"), "event", "obj"), "enum": ObjType(_("enum"), "enum", "obj", "type"), + "struct": ObjType(_("struct"), "struct", "obj", "type"), "alternate": ObjType(_("alternate"), "alt", "obj", "type"), } @@ -516,6 +523,7 @@ class QAPIDomain(Domain): "command": QAPICommand, "event": QAPIEvent, "enum": QAPIEnum, + "struct": QAPIStruct, "alternate": QAPIAlternate, } @@ -527,6 +535,7 @@ class QAPIDomain(Domain): "cmd": QAPIXRefRole(), "event": QAPIXRefRole(), "enum": QAPIXRefRole(), + "struct": QAPIXRefRole(), "alt": QAPIXRefRole(), # reference any data type (excludes modules, commands, events) "type": QAPIXRefRole(), -- 2.47.0