From nobody Mon Nov 25 01:28:58 2024 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=1719440826; cv=none; d=zohomail.com; s=zohoarc; b=ejlu29bA31k7tTZp8gqvrPRel5VePG07qP0YDAlhe9NXx4K38dfytz4XOvirT95Kd0TTV/YieISbRO58nrMVQGhZjiDERoeFgq5Birh66Ub/zwJnUzxIK+hkFwIIPC22EJaSbu6uNs+nb5GBrlrsZClCvvnE9kb9zT87CXrSVzk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1719440826; h=Content-Type: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=2nzBpnjScoftNaY4AnAB6wae3/qUvfG8R3aKq/DjlyA=; b=IljQ+CG3F0guEE2vTUPJzILEGMSEXILVqYkvx+w4arcZT/qSXBsOhrWmZuftDzbId0v/Jr6nilPZAPW/K7AGJq9QdrJY9/jU3T45dX8jYK5A/wqaaWvkLDX5Kc5G1u/KJ4cDTJvz+UE9I8W1NcubBQCw9BQjl4y3ArGnA90lvXQ= 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 1719440826385994.9118813533543; Wed, 26 Jun 2024 15:27:06 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sMb49-0000GO-PW; Wed, 26 Jun 2024 18:24:38 -0400 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 1sMb3a-0007dD-Hh for qemu-devel@nongnu.org; Wed, 26 Jun 2024 18:24:06 -0400 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 1sMb3Y-0002tv-Qq for qemu-devel@nongnu.org; Wed, 26 Jun 2024 18:24:02 -0400 Received: from mx-prod-mc-01.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-132-OWrQOqDONSiBSWZxQvCzFA-1; Wed, 26 Jun 2024 18:23:58 -0400 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (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-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 109A819560A0; Wed, 26 Jun 2024 22:23:56 +0000 (UTC) Received: from scv.redhat.com (unknown [10.22.8.67]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id EDFDA19560BF; Wed, 26 Jun 2024 22:23:46 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1719440640; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=2nzBpnjScoftNaY4AnAB6wae3/qUvfG8R3aKq/DjlyA=; b=VEaejZm5kalM7yEvTxNA/08D46FjQ3v55xmBEZ2+hK5OXK6j5BDUANInu5LAoVN5zNVMpZ 32K+pFdmc7MmbT5cI1pR1DuJsnQNz6gpHdJGrf3oW8XzGEFSscvicXDoIV8PdccbfCX9qy niiVB7P2SP98lebuJKeMiZeVnbr0ajA= X-MC-Unique: OWrQOqDONSiBSWZxQvCzFA-1 From: John Snow To: qemu-devel@nongnu.org Cc: Mads Ynddal , Jiri Pirko , Stefan Hajnoczi , Eric Blake , Peter Maydell , Michael Roth , "Michael S. Tsirkin" , Alex Williamson , Pavel Dovgalyuk , Victor Toso de Carvalho , =?UTF-8?q?C=C3=A9dric=20Le=20Goater?= , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , qemu-block@nongnu.org, Ani Sinha , Fabiano Rosas , Marcel Apfelbaum , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Gerd Hoffmann , Paolo Bonzini , Kevin Wolf , Peter Xu , Eduardo Habkost , Markus Armbruster , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Lukas Straub , Igor Mammedov , Jason Wang , Yanan Wang , Hanna Reitz , Konstantin Kostiuk , Stefan Berger , John Snow Subject: [PATCH v2 16/21] docs/qapidoc: add QMP highlighting to annotated qmp-example blocks Date: Wed, 26 Jun 2024 18:21:22 -0400 Message-ID: <20240626222128.406106-17-jsnow@redhat.com> In-Reply-To: <20240626222128.406106-1-jsnow@redhat.com> References: <20240626222128.406106-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 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: -22 X-Spam_score: -2.3 X-Spam_bar: -- X-Spam_report: (-2.3 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.207, 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_H4=0.001, RCVD_IN_MSPIKE_WL=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: 1719440827982100007 For any code literal blocks inside of a qmp-example directive, apply and enforce the QMP lexer/highlighter to those blocks. This way, you won't need to write: ``` .. qmp-example:: :annotated: Blah blah .. code-block:: QMP -> { "lorem": "ipsum" } ``` But instead, simply: ``` .. qmp-example:: :annotated: Blah blah:: -> { "lorem": "ipsum" } ``` Once the directive block is exited, whatever the previous default highlight language was will be restored; localizing the forced QMP lexing to exclusively this directive. Signed-off-by: John Snow --- docs/sphinx/qapidoc.py | 53 ++++++++++++++++++++++++++++++++++++++---- 1 file changed, 49 insertions(+), 4 deletions(-) diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index a2fa05fc491..c8c404ad1b0 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -26,6 +26,7 @@ =20 import os import re +import sys import textwrap from typing import List =20 @@ -37,6 +38,7 @@ from qapi.schema import QAPISchema =20 import sphinx +from sphinx import addnodes from sphinx.directives.code import CodeBlock from sphinx.errors import ExtensionError from sphinx.util.docutils import SphinxDirective @@ -575,10 +577,10 @@ class QMPExample(CodeBlock, NestedDirective): Custom admonition for QMP code examples. =20 When the :annotated: option is present, the body of this directive - is parsed as normal rST instead. Code blocks must be explicitly - written by the user, but this allows for intermingling explanatory - paragraphs with arbitrary rST syntax and code blocks for more - involved examples. + is parsed as normal rST, but with any '::' code blocks set to use + the QMP lexer. Code blocks must be explicitly written by the user, + but this allows for intermingling explanatory paragraphs with + arbitrary rST syntax and code blocks for more involved examples. =20 When :annotated: is absent, the directive body is treated as a simple standalone QMP code block literal. @@ -592,6 +594,33 @@ class QMPExample(CodeBlock, NestedDirective): "title": directives.unchanged, } =20 + def _highlightlang(self) -> addnodes.highlightlang: + """Return the current highlightlang setting for the document""" + node =3D None + doc =3D self.state.document + + if hasattr(doc, "findall"): + # docutils >=3D 0.18.1 + for node in doc.findall(addnodes.highlightlang): + pass + else: + for elem in doc.traverse(): + if isinstance(elem, addnodes.highlightlang): + node =3D elem + + if node: + return node + + # No explicit directive found, use defaults + node =3D addnodes.highlightlang( + lang=3Dself.env.config.highlight_language, + force=3DFalse, + # Yes, Sphinx uses this value to effectively disable line + # numbers and not 0 or None or -1 or something. =C2=AF\_(=E3= =83=84)_/=C2=AF + linenothreshold=3Dsys.maxsize, + ) + return node + def admonition_wrap(self, *content) -> List[nodes.Node]: title =3D "Example:" if "title" in self.options: @@ -606,8 +635,24 @@ def admonition_wrap(self, *content) -> List[nodes.Node= ]: return [admon] =20 def run_annotated(self) -> List[nodes.Node]: + lang_node =3D self._highlightlang() + content_node: nodes.Element =3D nodes.section() + + # Configure QMP highlighting for "::" blocks, if needed + if lang_node["lang"] !=3D "QMP": + content_node +=3D addnodes.highlightlang( + lang=3D"QMP", + force=3DFalse, # "True" ignores lexing errors + linenothreshold=3Dlang_node["linenothreshold"], + ) + self.do_parse(self.content, content_node) + + # Restore prior language highlighting, if needed + if lang_node["lang"] !=3D "QMP": + content_node +=3D addnodes.highlightlang(**lang_node.attribute= s) + return content_node.children =20 def run(self) -> List[nodes.Node]: --=20 2.45.0