sphinx/qapidoc: Drop code to generate doc for simple union tag
authorMarkus Armbruster <armbru@redhat.com>
Mon, 5 Feb 2024 07:46:59 +0000 (08:46 +0100)
committerMarkus Armbruster <armbru@redhat.com>
Mon, 12 Feb 2024 09:04:31 +0000 (10:04 +0100)
QAPISchemaGenRSTVisitor._nodes_for_members() has a special case to
auto-generate documentation for a union tag member of implicit (enum)
type that lacks documentation.

This was useful for simple unions, where the tag member's type was
implicitly.  The only implicit enum type left today is 'QType'.  Not
worth a special case.  Drop.  No change to generated documentation.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-6-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
docs/sphinx/qapidoc.py

index 658c288f8fe9b674e8c7230053658f44934145e5..05b809af27da36eba10a4d32306a198d04aedbca 100644 (file)
@@ -168,12 +168,6 @@ class QAPISchemaGenRSTVisitor(QAPISchemaVisitor):
             # TODO drop fallbacks when undocumented members are outlawed
             if section.text:
                 defn = section.text
-            elif (variants and variants.tag_member == section.member
-                  and not section.member.type.doc_type()):
-                values = section.member.type.member_names()
-                defn = [nodes.Text('One of ')]
-                defn.extend(intersperse([nodes.literal('', v) for v in values],
-                                        nodes.Text(', ')))
             else:
                 defn = [nodes.Text('Not documented')]