From nobody Wed Jan 29 00:07:51 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=1734052601; cv=none; d=zohomail.com; s=zohoarc; b=clCBmAltuveQ8yU302rQmVUVlEqSfVaZ9he8u6QkLviwp9JN/9OMlojo8k0kRZqTu+7Xxti7AWEY4REd3oe8K/bdk+NWG4XRWjRC2FN3Q48iMcqdxWIU2eMLuPdxhGW+fPQzdL8hIOjyfPsLIbVW+mYYi10MPdJGyrCMDNYxkSc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1734052601; 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=m/sKnpk4pWfDahNw9QpklkpBz6Dn/PXW1JplulpPypo=; b=gGsEHewNv3eazk5WWpGkWMKC+wEGRjd+0Z4iJd+j8+iRdJEWc88yEjBAwZ7ugOjYgOyfXGQ9cjK79m8P4ofRjYMJoagaSRO3x1mRPciBTtPFi88N08q4/5UyRo/SISJicOFhzfQp3fEb1TfrcEPwQz4S/77oh57BvxpqgZxfMu4= 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 1734052601144433.534779131405; Thu, 12 Dec 2024 17:16:41 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tLuFf-0005Xp-DG; Thu, 12 Dec 2024 20:13:55 -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 1tLuFd-0005Xe-HD for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:13:53 -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 1tLuFa-00007g-6U for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:13:53 -0500 Received: from mx-prod-mc-02.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-644-y5oe0uLtMhifXf8MOyoqVA-1; Thu, 12 Dec 2024 20:13:46 -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-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 461371956051; Fri, 13 Dec 2024 01:13:44 +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 E465D1956086; Fri, 13 Dec 2024 01:13:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1734052429; 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=m/sKnpk4pWfDahNw9QpklkpBz6Dn/PXW1JplulpPypo=; b=fI81zmrIXslucaHkqe0KifmUbFKjx7nasFBz3IaogDn4kfObS2r6g9J7G83BFgbyM+2ZbU rjtTbQO9+Yjn0YKs3BTeV2nahGWxvZdUAFU4wpWr3HZET+tJHJ0qeu6gXhz+imYM9gSr2T DF+pucEifuSCLGrangkDwcMrwjAAWtw= X-MC-Unique: y5oe0uLtMhifXf8MOyoqVA-1 X-Mimecast-MFC-AGG-ID: y5oe0uLtMhifXf8MOyoqVA 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 05/35] docs/qapi-domain: add qapi:module directive Date: Thu, 12 Dec 2024 20:12:34 -0500 Message-ID: <20241213011307.2942030-6-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: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.496, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-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, SPF_PASS=-0.001 autolearn=ham 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: 1734052601757116600 Content-Type: text/plain; charset="utf-8" This adds a qapi:module directive, which just notes the current module being documented and performs a nested parse of the content block, if present. This code is based pretty heavily on Sphinx's PyModule directive, but with unnecessary features excised. For example: .. qapi:module:: block-core Hello, and welcome to block-core! =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D lorem ipsum, dolor sit amet ... Signed-off-by: John Snow --- docs/sphinx/qapi-domain.py | 106 ++++++++++++++++++++++++++++++++++++- 1 file changed, 105 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/qapi-domain.py b/docs/sphinx/qapi-domain.py index 293cb922861..57b35cf1f53 100644 --- a/docs/sphinx/qapi-domain.py +++ b/docs/sphinx/qapi-domain.py @@ -7,21 +7,119 @@ from typing import ( TYPE_CHECKING, Any, + ClassVar, Dict, + Iterable, List, Tuple, + cast, ) =20 +from docutils import nodes +from docutils.parsers.rst import directives + +from compat import nested_parse +from sphinx import addnodes from sphinx.domains import Domain, ObjType from sphinx.util import logging +from sphinx.util.docutils import SphinxDirective +from sphinx.util.nodes import make_id =20 =20 if TYPE_CHECKING: + from docutils.nodes import Element, Node + from sphinx.application import Sphinx + from sphinx.util.typing import OptionSpec =20 logger =3D logging.getLogger(__name__) =20 =20 +class QAPIModule(SphinxDirective): + """ + Directive to mark description of a new module. + + This directive doesn't generate any special formatting, and is just + a pass-through for the content body. Named section titles are + allowed in the content body. + + Use this directive to associate subsequent definitions with the + module they are defined in for purposes of search and QAPI index + organization. + + :arg: The name of the module. + :opt no-index: Don't add cross-reference targets or index entries. + :opt no-typesetting: Don't render the content body (but preserve any + cross-reference target IDs in the squelched output.) + + Example:: + + .. qapi:module:: block-core + :no-index: + :no-typesetting: + + Lorem ipsum, dolor sit amet ... + + """ + + has_content =3D True + required_arguments =3D 1 + optional_arguments =3D 0 + final_argument_whitespace =3D False + + option_spec: ClassVar[OptionSpec] =3D { + # These are universal "Basic" options; + # https://www.sphinx-doc.org/en/master/usage/domains/index.html#ba= sic-markup + "no-index": directives.flag, + "no-typesetting": directives.flag, + "no-contents-entry": directives.flag, # NB: No effect + # Deprecated aliases; to be removed in Sphinx 9.0 + "noindex": directives.flag, + "nocontentsentry": directives.flag, # NB: No effect + } + + def run(self) -> List[Node]: + modname =3D self.arguments[0].strip() + no_index =3D "no-index" in self.options or "noindex" in self.optio= ns + + self.env.ref_context["qapi:module"] =3D modname + + content_node: Element =3D nodes.section() + nested_parse(self, content_node) + + ret: List[Node] =3D [] + inode =3D addnodes.index(entries=3D[]) + + if not no_index: + node_id =3D make_id(self.env, self.state.document, "module", m= odname) + target =3D nodes.target("", "", ids=3D[node_id], ismod=3DTrue) + self.set_source_info(target) + self.state.document.note_explicit_target(target) + + indextext =3D f"QAPI module; {modname}" + inode =3D addnodes.index( + entries=3D[ + ("pair", indextext, node_id, "", None), + ] + ) + ret.append(inode) + content_node.insert(0, target) + + if "no-typesetting" in self.options: + if node_ids :=3D [ + node_id + for el in content_node.findall(nodes.Element) + for node_id in cast(Iterable[str], el.get("ids", ())) + ]: + target =3D nodes.target(ids=3Dnode_ids) + self.set_source_info(target) + ret.append(target) + else: + ret.extend(content_node.children) + + return ret + + class QAPIDomain(Domain): """QAPI language domain.""" =20 @@ -29,7 +127,13 @@ class QAPIDomain(Domain): label =3D "QAPI" =20 object_types: Dict[str, ObjType] =3D {} - directives =3D {} + + # Each of these provides a rST directive, + # e.g. .. qapi:module:: block-core + directives =3D { + "module": QAPIModule, + } + roles =3D {} initial_data: Dict[str, Dict[str, Tuple[Any]]] =3D {} indices =3D [] --=20 2.47.0