From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id C912CC2BD09 for ; Fri, 28 Jun 2024 13:24:47 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sNBaV-0005A8-FS; Fri, 28 Jun 2024 09:24:27 -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 1sNBaT-00052i-Sp for qemu-devel@nongnu.org; Fri, 28 Jun 2024 09:24:25 -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 1sNBaR-0002lm-PW for qemu-devel@nongnu.org; Fri, 28 Jun 2024 09:24:25 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1719581062; 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: in-reply-to:in-reply-to:references:references; bh=ouN/o+oMMm9rmJth6ObVsdneUwLWuXsxDQ19GX5MYS8=; b=aVWyU2ikJJ6+egSgjyyzgSTiwQGsNwZD5HgmbM2WGxArxMyzW4oL8BXBoarQ+/9I4cm6uI QI7n3LloraxUp2ziv/kXMC63F4dOqc8SX492m8wEcxe2H/UDqRZ6sIeDKQv4aZ7ZWXXJf8 /cXdmUUxpgib2/reNC5UbCpwOLPKdUw= 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-470-XYwvvhmPPj6TzYww4deuBw-1; Fri, 28 Jun 2024 09:24:18 -0400 X-MC-Unique: XYwvvhmPPj6TzYww4deuBw-1 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-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 588F91954B24; Fri, 28 Jun 2024 13:24:15 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.194.114]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 3C27A1955BD4; Fri, 28 Jun 2024 13:24:14 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 5D59621E668B; Fri, 28 Jun 2024 15:24:12 +0200 (CEST) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, 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?= Le Goater , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , qemu-block@nongnu.org, Ani Sinha , Fabiano Rosas , Marcel Apfelbaum , =?utf-8?Q?Marc-Andr=C3=A9?= Lureau , Gerd Hoffmann , Paolo Bonzini , Kevin Wolf , Peter Xu , Eduardo Habkost , Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= , Lukas Straub , Igor Mammedov , Jason Wang , Yanan Wang , Hanna Reitz , Konstantin Kostiuk Subject: Re: [PATCH v2 15/21] docs/qapidoc: create qmp-example directive In-Reply-To: <20240626222128.406106-16-jsnow@redhat.com> (John Snow's message of "Wed, 26 Jun 2024 18:21:21 -0400") References: <20240626222128.406106-1-jsnow@redhat.com> <20240626222128.406106-16-jsnow@redhat.com> Date: Fri, 28 Jun 2024 15:24:12 +0200 Message-ID: <87msn5xksj.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 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: -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.206, 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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org John Snow writes: > This is a directive that creates a syntactic sugar for creating > "Example" boxes very similar to the ones already used in the bitmaps.rst > document, please see e.g. > https://www.qemu.org/docs/master/interop/bitmaps.html#creation-block-dirty-bitmap-add > > In its simplest form, when a custom title is not needed or wanted, and > the example body is *solely* a QMP example: > > ``` > .. qmp-example:: > > {body} > ``` > > is syntactic sugar for: > > ``` > .. admonition:: Example: > > .. code-block:: QMP > > {body} > ``` > > When a custom, plaintext title that describes the example is desired, > this form: > > ``` > .. qmp-example:: > :title: Defrobnification > > {body} > ``` > > Is syntactic sugar for: > > ``` > .. admonition:: Example: Defrobnification > > .. code-block:: QMP > > {body} > ``` > > Lastly, when Examples are multi-step processes that require non-QMP > exposition, have lengthy titles, or otherwise involve prose with rST > markup (lists, cross-references, etc), the most complex form: > > ``` > .. qmp-example:: > :annotated: > > This example shows how to use `foo-command`:: > > {body} > ``` > > Is desugared to: > > ``` > .. admonition:: Example: > > This example shows how to use `foo-command`:: > > {body} > > For more information, please see `frobnozz`. > ``` Can we combine the latter two? Like this: .. qmp-example:: :title: Defrobnification :annotated: This example shows how to use `foo-command`:: {body} > The primary benefit here being documentation source consistently using > the same directive for all forms of examples to ensure consistent visual > styling, and ensuring all relevant prose is visually grouped alongside > the code literal block. > > Note that as of this commit, the code-block rST syntax "::" does not > apply QMP highlighting; you would need to use ".. code-block:: QMP". The > very next commit changes this behavior to assume all "::" code blocks > within this directive are QMP blocks. > > Signed-off-by: John Snow > --- > docs/sphinx/qapidoc.py | 60 ++++++++++++++++++++++++++++++++++++++++-- > 1 file changed, 58 insertions(+), 2 deletions(-) No tests? Hmm, I see you convert existing tests in PATCH 19-21. While that works, test coverage now would make it easier to see how each patch affects doc generator output. > diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py > index 43dd99e21e6..a2fa05fc491 100644 > --- a/docs/sphinx/qapidoc.py > +++ b/docs/sphinx/qapidoc.py > @@ -27,16 +27,19 @@ > import os > import re > import textwrap > +from typing import List > > from docutils import nodes > -from docutils.parsers.rst import Directive, directives > +from docutils.parsers.rst import directives > from docutils.statemachine import ViewList > from qapi.error import QAPIError, QAPISemError > from qapi.gen import QAPISchemaVisitor > from qapi.schema import QAPISchema > > import sphinx > +from sphinx.directives.code import CodeBlock > from sphinx.errors import ExtensionError > +from sphinx.util.docutils import SphinxDirective > from sphinx.util.nodes import nested_parse_with_titles > > > @@ -494,7 +497,7 @@ def visit_module(self, name): > super().visit_module(name) > > > -class NestedDirective(Directive): > +class NestedDirective(SphinxDirective): What is this about? > def run(self): > raise NotImplementedError > > @@ -567,10 +570,63 @@ def run(self): > raise ExtensionError(str(err)) from err > > > +class QMPExample(CodeBlock, NestedDirective): > + """ > + Custom admonition for QMP code examples. > + > + 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. > + > + When :annotated: is absent, the directive body is treated as a > + simple standalone QMP code block literal. > + """ > + > + required_argument = 0 > + optional_arguments = 0 > + has_content = True > + option_spec = { > + "annotated": directives.flag, > + "title": directives.unchanged, > + } > + > + def admonition_wrap(self, *content) -> List[nodes.Node]: > + title = "Example:" > + if "title" in self.options: > + title = f"{title} {self.options['title']}" > + > + admon = nodes.admonition( > + "", > + nodes.title("", title), > + *content, > + classes=["admonition", "admonition-example"], > + ) > + return [admon] > + > + def run_annotated(self) -> List[nodes.Node]: > + content_node: nodes.Element = nodes.section() > + self.do_parse(self.content, content_node) > + return content_node.children > + > + def run(self) -> List[nodes.Node]: > + annotated = "annotated" in self.options > + > + if annotated: > + content_nodes = self.run_annotated() > + else: > + self.arguments = ["QMP"] > + content_nodes = super().run() > + > + return self.admonition_wrap(*content_nodes) > + > + > def setup(app): > """Register qapi-doc directive with Sphinx""" > app.add_config_value("qapidoc_srctree", None, "env") > app.add_directive("qapi-doc", QAPIDocDirective) > + app.add_directive("qmp-example", QMPExample) > > return { > "version": __version__,