From nobody Thu Sep 19 01:58:59 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=1721213406; cv=none; d=zohomail.com; s=zohoarc; b=G/7l+69GLOcEJnYGe7wIe+ZnW9xxp8bm7Yy3kYGwgACacfXxF9eIOTT1kHehD4PgWat7r+Pou/Y+2c/kUtwpldueauo1E6Qg9dYrxjUp7mseex4Jtz9gath128PiEkfUCIsrslabAUkzu7uWIoUQW8s09vz0FiIeNu+mGT3qgS0= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1721213406; 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=dObJt2hzSae9YWVdp7i5Jpit7nSp6I6pfpfuuGscgIo=; b=cDMyXluZp0z5yldJGjozaEwrLulwlL8WJVcm3OizaAzv6MDwmBDa7OqvNHpQ1ez6TQwGrLRuF2xX2548TPmDF7UXjf4V226NaerN51gyfU6tURJioR1UA4bSwR8/zwQTPtOLkxBYr/KGgBcZJWWZfCrBmxmO/0RTamO043iatVc= 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 1721213406794466.40633005292364; Wed, 17 Jul 2024 03:50:06 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sU2Do-0003wi-R0; Wed, 17 Jul 2024 06:49:20 -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 1sU2Dn-0003s0-K8 for qemu-devel@nongnu.org; Wed, 17 Jul 2024 06:49:19 -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 1sU2Dl-0001V0-Nr for qemu-devel@nongnu.org; Wed, 17 Jul 2024 06:49:19 -0400 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-344-4nytgWZsO66QMcY9Y89pfg-1; Wed, 17 Jul 2024 06:49:13 -0400 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 15BF01955F0D; Wed, 17 Jul 2024 10:49:13 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.65]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 836911955D47; Wed, 17 Jul 2024 10:49:12 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id D418421E65D1; Wed, 17 Jul 2024 12:49:07 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1721213357; 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=dObJt2hzSae9YWVdp7i5Jpit7nSp6I6pfpfuuGscgIo=; b=LLsgUpO7+C3DWNBpz9my6VqMjrlloIZ0RzLkafE2xRP1RBC4joZSxrZgglh6nEoYgrGnto ECdE7qSMMPPvom2P3vjMsA62W28ZO2ckhTn83lsvIBD29qcZPqb6POLlqZo0/pD2iLaWgj Qg6F6BSd5ZfvAMn4JQTWUyBLSMM/3EM= X-MC-Unique: 4nytgWZsO66QMcY9Y89pfg-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: richard.henderson@linaro.org, John Snow Subject: [PULL 09/14] docs/qapidoc: add QMP highlighting to annotated qmp-example blocks Date: Wed, 17 Jul 2024 12:49:02 +0200 Message-ID: <20240717104907.2962784-10-armbru@redhat.com> In-Reply-To: <20240717104907.2962784-1-armbru@redhat.com> References: <20240717104907.2962784-1-armbru@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=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: 12 X-Spam_score: 1.2 X-Spam_bar: + X-Spam_report: (1.2 / 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, PP_MIME_FAKE_ASCII_TEXT=0.001, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_SBL_CSS=3.335, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 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: 1721213408834116600 Content-Type: text/plain; charset="utf-8" From: John Snow 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. Note, if the default language is *already* QMP, this directive will not generate and restore redundant highlight configuration nodes. We may well decide that the default language ought to be QMP for any QAPI reference pages, but this way the directive behaves consistently no matter where it is used. Signed-off-by: John Snow Acked-by: Markus Armbruster Message-ID: <20240717021312.606116-5-jsnow@redhat.com> Signed-off-by: Markus Armbruster --- 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 11defcfa3f..738b2450fb 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 @@ -36,6 +37,7 @@ from qapi.gen import QAPISchemaVisitor from qapi.schema import QAPISchema =20 +from sphinx import addnodes from sphinx.directives.code import CodeBlock from sphinx.errors import ExtensionError from sphinx.util.docutils import switch_source_input @@ -545,10 +547,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. @@ -562,6 +564,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. \ufffd\ufffd\_= (\ufffd\ufffd\ufffd)_/\ufffd\ufffd + linenothreshold=3Dsys.maxsize, + ) + return node + def admonition_wrap(self, *content) -> List[nodes.Node]: title =3D "Example:" if "title" in self.options: @@ -576,8 +605,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