From nobody Thu Apr 3 09:59:34 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=1741146677; cv=none; d=zohomail.com; s=zohoarc; b=iZPiqdqcoUIVpZzhj3hVRcBS0XYOdnDHM9rkDjhXY37jg3HxbK3tf8zIjA6qooREUaY/squYvWbYVMtGBKkRxX40IwFeiOgu/2N/Hk6zu12H3mCYytD1niVnH2i/SWejTSDIveJ9nAlNbCm2rx12sK1mfdM/zh5WMY6F6YXdqss= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1741146677; 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=fpVyk2E5pAwiy0sgPsc+TmBNJh6lnIFuE7eKJHXQ3sQ=; b=Bh8FppxpR9aaa6UewFGtz1ENCC/8AjESMSycNaOSl7gOmoLewll9W4GeJ8k92G+KolD5pZuoFIv+0Br7Fao0Z8+Gy1NmuMYIVQQXrgSqEMyMuJNwrJ1KBuJc78gEKJLTpvnVUXrTR7Sh0a27DTjXV8ZRPPRllt11LaocC1pi67Y= 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 1741146677860650.6547084963426; Tue, 4 Mar 2025 19:51:17 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tpflY-0006uY-LZ; Tue, 04 Mar 2025 22:49:52 -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 1tpflL-0005ii-EI for qemu-devel@nongnu.org; Tue, 04 Mar 2025 22:49:39 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tpflJ-0006Ue-DT for qemu-devel@nongnu.org; Tue, 04 Mar 2025 22:49:39 -0500 Received: from mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-313-drpvy9BQPD-oN-EzBQunpQ-1; Tue, 04 Mar 2025 22:49:30 -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-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id BEA1D180035D; Wed, 5 Mar 2025 03:49:28 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.80.45]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 380ED1956095; Wed, 5 Mar 2025 03:49:24 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1741146576; 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=fpVyk2E5pAwiy0sgPsc+TmBNJh6lnIFuE7eKJHXQ3sQ=; b=dpkQlm3hX+uL+PvudjxThyKu+Z1qagN/ELsN7BaSk+aQkgBnV8K9p9vbiT+D8MeBC3iLEd AnbVyoMn7kELIJNPKl0gwSPR+cfzwhNLS+6YnEZv7Nlk05tmLfPjhtd+ramyYG5HBGfR2L B0jKgHsgPJwMdH2HMppNenGV1vZCOr4= X-MC-Unique: drpvy9BQPD-oN-EzBQunpQ-1 X-Mimecast-MFC-AGG-ID: drpvy9BQPD-oN-EzBQunpQ_1741146568 From: John Snow To: qemu-devel@nongnu.org Cc: Michael Roth , =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Peter Maydell , Thomas Huth , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Markus Armbruster , John Snow Subject: [PATCH 52/57] docs/qapidoc: implement transmogrify() method Date: Tue, 4 Mar 2025 22:46:01 -0500 Message-ID: <20250305034610.960147-53-jsnow@redhat.com> In-Reply-To: <20250305034610.960147-1-jsnow@redhat.com> References: <20250305034610.960147-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.129.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, 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_H5=0.001, RCVD_IN_MSPIKE_WL=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: 1741146679849019000 Content-Type: text/plain; charset="utf-8" This is the true top-level processor for the new transmogrifier; responsible both for generating the intermediate rST and then running the nested parse on that generated document to produce the final docutils tree that is then - very finally - postprocessed by sphinx for final rendering to HTML &c. Signed-off-by: John Snow --- docs/sphinx/qapidoc.py | 49 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 48 insertions(+), 1 deletion(-) diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index fb2ad7492ae..a4a0523d8ef 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -2,6 +2,7 @@ # # QEMU qapidoc QAPI file parsing extension # +# Copyright (c) 2024 Red Hat # Copyright (c) 2020 Linaro # # This work is licensed under the terms of the GNU GPLv2 or later. @@ -24,6 +25,8 @@ https://www.sphinx-doc.org/en/master/development/index.html """ =20 +# pylint: disable=3Dtoo-many-lines + from __future__ import annotations =20 from contextlib import contextmanager @@ -56,6 +59,7 @@ from sphinx import addnodes from sphinx.directives.code import CodeBlock from sphinx.errors import ExtensionError +from sphinx.util import logging from sphinx.util.docutils import switch_source_input from sphinx.util.nodes import nested_parse_with_titles =20 @@ -76,6 +80,8 @@ =20 __version__ =3D "1.0" =20 +logger =3D logging.getLogger(__name__) + =20 class Transmogrifier: # pylint: disable=3Dtoo-many-public-methods @@ -95,6 +101,10 @@ def __init__(self) -> None: self._result =3D StringList() self.indent =3D 0 =20 + @property + def result(self) -> StringList: + return self._result + @property def entity(self) -> QAPISchemaDefinition: assert self._curr_ent is not None @@ -444,7 +454,43 @@ def new_serialno(self) -> str: return "qapidoc-%d" % env.new_serialno("qapidoc") =20 def transmogrify(self, schema: QAPISchema) -> nodes.Element: - raise NotImplementedError + logger.info("Transmogrifying QAPI to rST ...") + vis =3D Transmogrifier() + modules =3D set() + + for doc in schema.docs: + module_source =3D doc.info.fname + if module_source not in modules: + vis.visit_module(module_source) + modules.add(module_source) + + if doc.symbol: + ent =3D schema.lookup_entity(doc.symbol) + assert isinstance(ent, QAPISchemaDefinition) + vis.visit_entity(ent) + else: + vis.visit_freeform(doc) + + logger.info("Transmogrification complete.") + + contentnode =3D nodes.section() + content =3D vis.result + titles_allowed =3D True + + logger.info("Transmogrifier running nested parse ...") + with switch_source_input(self.state, content): + if titles_allowed: + node: nodes.Element =3D nodes.section() + node.document =3D self.state.document + nested_parse_with_titles(self.state, content, contentnode) + else: + node =3D nodes.paragraph() + node.document =3D self.state.document + self.state.nested_parse(content, 0, contentnode) + logger.info("Transmogrifier's nested parse completed.") + sys.stdout.flush() + + return contentnode =20 def legacy(self, schema: QAPISchema) -> nodes.Element: vis =3D QAPISchemaGenRSTVisitor(self) @@ -578,6 +624,7 @@ def run(self) -> List[nodes.Node]: =20 def setup(app: Sphinx) -> ExtensionMetadata: """Register qapi-doc directive with Sphinx""" + app.setup_extension("qapi_domain") app.add_config_value("qapidoc_srctree", None, "env") app.add_directive("qapi-doc", QAPIDocDirective) app.add_directive("qmp-example", QMPExample) --=20 2.48.1