From patchwork Mon May 6 11:02:44 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Markus Armbruster X-Patchwork-Id: 13655324 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 9DF12C10F16 for ; Mon, 6 May 2024 11:07:31 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1s3w7l-0002xo-8K; Mon, 06 May 2024 07:03:13 -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 1s3w7f-0002oU-0N for qemu-devel@nongnu.org; Mon, 06 May 2024 07:03:09 -0400 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 1s3w7X-0003f7-Lo for qemu-devel@nongnu.org; Mon, 06 May 2024 07:03:06 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1714993379; 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=CST8hJi+JjS3q3FB4kEBCJTRkwPPNE8vTTYwVXxChSI=; b=S8/x6wdGScAlwYR2TWjfskEZ/UvB+l5uwyxhyJsb/LYgI745ZkANLKndT2PXjBDc1X25eP I+4JZewszX1MQEqbJfDQYETjHfG+Zr6jwVXyCP2Q2GUVq68cFuKY5htX1O/PGE3tY0UKQV wMK9PWm4b00w8OF1DyIcUSJeQVR/tSk= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-49-AkeHUL-kN5CdO1Kjl6AW5Q-1; Mon, 06 May 2024 07:02:55 -0400 X-MC-Unique: AkeHUL-kN5CdO1Kjl6AW5Q-1 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) (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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id 5EE3C80BB33; Mon, 6 May 2024 11:02:55 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.247]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 27419EC683; Mon, 6 May 2024 11:02:55 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 41F3621E64D0; Mon, 6 May 2024 13:02:54 +0200 (CEST) From: Markus Armbruster To: qemu-devel@nongnu.org Cc: richard.henderson@linaro.org Subject: [PATCH 2/7] sphinx/qapidoc: Tweak "Since" section formatting WIP Date: Mon, 6 May 2024 13:02:44 +0200 Message-ID: <20240506110254.3965097-5-armbru@redhat.com> In-Reply-To: <20240506110254.3965097-1-armbru@redhat.com> References: <20240506110254.3965097-1-armbru@redhat.com> MIME-Version: 1.0 Content-type: text/plain X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.5 Received-SPF: pass client-ip=170.10.129.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -26 X-Spam_score: -2.7 X-Spam_bar: -- X-Spam_report: (-2.7 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.581, 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 --- docs/sphinx/qapidoc.py | 6 +++--- tests/qapi-schema/doc-good.txt | 6 +----- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index ac81003f0e..f19f5ded78 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -252,9 +252,9 @@ def _nodes_for_features(self, doc): def _nodes_for_since(self, doc): if doc.since: - section = self._make_section('Since') - self._parse_text_into_node(doc.since.text, section) - return [section] + # TODO emphasis + return [nodes.paragraph( + '', '', nodes.Text('Since: ' + doc.since.text))] return [] def _nodes_for_example(self, exampletext): diff --git a/tests/qapi-schema/doc-good.txt b/tests/qapi-schema/doc-good.txt index 847db70412..56d50d4992 100644 --- a/tests/qapi-schema/doc-good.txt +++ b/tests/qapi-schema/doc-good.txt @@ -235,11 +235,7 @@ Examples - *verbatim* - {braces} - -Since -~~~~~ - -2.10 +Since: 2.10 "cmd-boxed" (Command)