From nobody Tue Jan 28 23:53:48 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1734052469; cv=none; d=zohomail.com; s=zohoarc; b=brLNyfYHTZs9FFJYKhZm7bDCD7rwK9Lb90bZG9z7QBmmbGwgI6bc27Q1iBR13SfCoCTucBWgxYDoT2QMMkkAIa8WoSyysw0TjTWIgYgJx06YNo/bJPnkzHxBraNMJmMGNCBZQ0mschD3KsrffqwetwgA1M2l36P6SWAXAd2luoI= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1734052469; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=xBuIfzlqNOz/6xZ6DSHAelvGOKi8S/vFA3f21PFplt4=; b=mybG3cujEnjgmJu4o6o2p3uCHoPX60QP3NnoIMmFce3oFXN4a7Co4jTN6RRiPubrb2JXFoe6XRQa8OD1m7rtShcB1ONVG/Uja/+/sa3I1yEhwXdGc38vTQUvqWfZGNX5YPbfAi7dpuFgC1i8quXUfUakxqXJHyMg7hor71kw9Qo= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1734052469754121.56726691258939; Thu, 12 Dec 2024 17:14:29 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tLuFp-0005Yp-Uv; Thu, 12 Dec 2024 20:14:05 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tLuFn-0005YP-UX for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:14:03 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tLuFf-0000G5-5Y for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:14:03 -0500 Received: from mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-170-cezUqv8RNCW4Xxx_u0Ji2Q-1; Thu, 12 Dec 2024 20:13:52 -0500 Received: from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 3100819560A5; Fri, 13 Dec 2024 01:13:51 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.88.22]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 060161956089; Fri, 13 Dec 2024 01:13:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1734052433; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=xBuIfzlqNOz/6xZ6DSHAelvGOKi8S/vFA3f21PFplt4=; b=PCMQE3QQLKzXaiFwRvUSUO+XqeSnNaD/VZZJWjaEXzaNb/KDzfEcsF6Mu0K82VzUxnOrKE p0oGcZ26jsXi2JyHt0R+9+zjFDcwIIFhItBy4KJuJ5+seMdpEmp0O1FMyn8fxTWZvBKi6b 8HyLmthlDqTjxUuiSvQ9DRBMuwHlujk= X-MC-Unique: cezUqv8RNCW4Xxx_u0Ji2Q-1 X-Mimecast-MFC-AGG-ID: cezUqv8RNCW4Xxx_u0Ji2Q From: John Snow To: qemu-devel@nongnu.org Cc: Michael Roth , Markus Armbruster , Peter Maydell , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Victor Toso de Carvalho , Paolo Bonzini , John Snow Subject: [RFC PATCH v2 07/35] docs/qapi-domain: add QAPI index Date: Thu, 12 Dec 2024 20:12:36 -0500 Message-ID: <20241213011307.2942030-8-jsnow@redhat.com> In-Reply-To: <20241213011307.2942030-1-jsnow@redhat.com> References: <20241213011307.2942030-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.133.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -16 X-Spam_score: -1.7 X-Spam_bar: - X-Spam_report: (-1.7 / 5.0 requ) BAYES_00=-1.9, DKIM_INVALID=0.1, DKIM_SIGNED=0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_NONE=0.001, T_SPF_TEMPERROR=0.01 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1734052471067116600 Content-Type: text/plain; charset="utf-8" Use the QAPI object registry to generate a special index just for QAPI definitions. The index can show entries both by definition type and alphabetically. The index can be linked from anywhere in the QEMU manual by using `qapi-index`. Signed-off-by: John Snow --- docs/sphinx/qapi-domain.py | 74 +++++++++++++++++++++++++++++++++++--- 1 file changed, 69 insertions(+), 5 deletions(-) diff --git a/docs/sphinx/qapi-domain.py b/docs/sphinx/qapi-domain.py index 76f10b942d7..a83041a0aac 100644 --- a/docs/sphinx/qapi-domain.py +++ b/docs/sphinx/qapi-domain.py @@ -12,6 +12,7 @@ Iterable, List, NamedTuple, + Optional, Tuple, cast, ) @@ -21,7 +22,12 @@ =20 from compat import nested_parse from sphinx import addnodes -from sphinx.domains import Domain, ObjType +from sphinx.domains import ( + Domain, + Index, + IndexEntry, + ObjType, +) from sphinx.locale import _, __ from sphinx.util import logging from sphinx.util.docutils import SphinxDirective @@ -52,9 +58,10 @@ class QAPIModule(SphinxDirective): a pass-through for the content body. Named section titles are allowed in the content body. =20 - Use this directive to associate subsequent definitions with the - module they are defined in for purposes of search and QAPI index - organization. + Use this directive to create entries for the QAPI module in the + global index and the qapi index; as well as to associate subsequent + definitions with the module they are defined in for purposes of + search and QAPI index organization. =20 :arg: The name of the module. :opt no-index: Don't add cross-reference targets or index entries. @@ -133,6 +140,60 @@ def run(self) -> List[Node]: return ret =20 =20 +class QAPIIndex(Index): + """ + Index subclass to provide the QAPI definition index. + """ + + name =3D "index" + localname =3D _("QAPI Index") + shortname =3D _("QAPI Index") + + def generate( + self, + docnames: Optional[Iterable[str]] =3D None, + ) -> Tuple[List[Tuple[str, List[IndexEntry]]], bool]: + assert isinstance(self.domain, QAPIDomain) + content: Dict[str, List[IndexEntry]] =3D {} + collapse =3D False + + # list of all object (name, ObjectEntry) pairs, sorted by name + # (ignoring the module) + objects =3D sorted( + self.domain.objects.items(), + key=3Dlambda x: x[0].split(".")[-1].lower(), + ) + + for objname, obj in objects: + if docnames and obj.docname not in docnames: + continue + + # Strip the module name out: + objname =3D objname.split(".")[-1] + + # Add an alphabetical entry: + entries =3D content.setdefault(objname[0].upper(), []) + entries.append( + IndexEntry( + objname, 0, obj.docname, obj.node_id, obj.objtype, "",= "" + ) + ) + + # Add a categorical entry: + category =3D obj.objtype.title() + "s" + entries =3D content.setdefault(category, []) + entries.append( + IndexEntry(objname, 0, obj.docname, obj.node_id, "", "", "= ") + ) + + # alphabetically sort categories; type names first, ABC entries la= st. + sorted_content =3D sorted( + content.items(), + key=3Dlambda x: (len(x[0]) =3D=3D 1, x[0]), + ) + return sorted_content, collapse + + class QAPIDomain(Domain): """QAPI language domain.""" =20 @@ -160,7 +221,10 @@ class QAPIDomain(Domain): "objects": {}, # fullname -> ObjectEntry } =20 - indices =3D [] + # Index pages to generate; each entry is an Index class. + indices =3D [ + QAPIIndex, + ] =20 @property def objects(self) -> Dict[str, ObjectEntry]: --=20 2.47.0