From nobody Sun Nov 24 10:56:20 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=1724359752; cv=none; d=zohomail.com; s=zohoarc; b=faEtKpwQvl7aoyhFCJLNd9uTyA/HsOuNw+PpXrXh1yO+qxtgg4cYnsb7jhjpny/a4vBKE81eFFACOLSX661eM1px+FucS1XfwCeDSKKhSXMKw3uegknIj4UzZfZfHgps58ZjVuuryKfpPQhvtmlpfBWDCjjm8X0GxjpL7Fpw4UU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1724359752; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=zosUzk9B68VtHH7N3AobXbVJFu38+x/Uj5JuI62Q+ws=; b=gY9WmV04bejUCRzaMtmvuYJUtYnwmFPAOKe2cSYt+9c69La8rx4Uq/amM9Oi6S3QnyatOJD4xqbU3LIX8sLHFYSsRLC08q5N66q3dqUsiKqjzS8ZlhCJGrXyOE1Iua0T9idGd6rdZG5hL1svoDNgpAWUeUJiVp5o5iG4+XZoCbo= 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 1724359752886647.1438258427389; Thu, 22 Aug 2024 13:49:12 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1shEjP-00089Z-Cq; Thu, 22 Aug 2024 16:48:31 -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 1shEjL-00088n-PO for qemu-devel@nongnu.org; Thu, 22 Aug 2024 16:48:28 -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 1shEj9-0003lD-78 for qemu-devel@nongnu.org; Thu, 22 Aug 2024 16:48:26 -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-173-5EJUZzipOU2SVlYZeXZuow-1; Thu, 22 Aug 2024 16:48:07 -0400 Received: from mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.17]) (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 9D4DE1955D52; Thu, 22 Aug 2024 20:48:05 +0000 (UTC) Received: from scv.localdomain (unknown [10.22.8.20]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 50CA319560A3; Thu, 22 Aug 2024 20:48:03 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1724359691; 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; bh=zosUzk9B68VtHH7N3AobXbVJFu38+x/Uj5JuI62Q+ws=; b=GiHZGkpdktDLLU36HIssMaPmxx6KiLFXiN4JPjv/OGVRk/4znLq0bUQk97BIGVjtnLVJO5 r/x/RjWg7hz2h+Se3XpR9zto7xkH7lOZ5YnW4ps65sbHZ0Hk3e1GV9+Ydhz/kt83uv0jmX tCYGRFxixkJpW45jkcZHNG4q5n6BUKM= X-MC-Unique: 5EJUZzipOU2SVlYZeXZuow-1 From: John Snow To: qemu-devel@nongnu.org Cc: Markus Armbruster , Peter Maydell , Michael Roth , John Snow Subject: [PATCH] docs/sphinx: fix extra stuff in TOC after freeform QMP sections Date: Thu, 22 Aug 2024 16:48:03 -0400 Message-ID: <20240822204803.1649762-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.17 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: -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.144, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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: 1724359755128116600 Content-Type: text/plain; charset="utf-8" Freeform sections with titles are currently generating a TOC entry for the first paragraph in the section after the header, which is not what we want. (Easiest to observe directly in the QMP reference manual's "Introduction" section.) When freeform sections are parsed, we create both a section header *and* an empty, title-less section. This causes some problems with sphinx's post-parse tree transforms, see also 2664f317 - this is a similar issue: Sphinx doesn't like section-less titles and it also doesn't like title-less sections. Modify qapidoc.py to parse text directly into the preceding section title as child nodes, eliminating the section duplication. This removes the extra text from the TOC. Only very, very lightly tested: "it looks right at a glance" :tm:. I am still in the process of rewriting qapidoc, so I didn't give it much deeper thought. Reported-by: Markus Armbruster Signed-off-by: John Snow Acked-by: Markus Armbruster Tested-by: Markus Armbruster --- docs/sphinx/qapidoc.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index 738b2450fb1..5f96b46270b 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -388,6 +388,7 @@ def _start_new_heading(self, heading, level): self._active_headings[level - 1] +=3D snode self._active_headings =3D self._active_headings[:level] self._active_headings.append(snode) + return snode =20 def _add_node_to_current_heading(self, node): """Add the node to whatever the current active heading is""" @@ -417,13 +418,11 @@ def freeform(self, doc): # the first line of the block) (heading, _, text) =3D text.partition('\n') (leader, _, heading) =3D heading.partition(' ') - self._start_new_heading(heading, len(leader)) + node =3D self._start_new_heading(heading, len(leader)) if text =3D=3D '': return =20 - node =3D self._make_section(None) self._parse_text_into_node(text, node) - self._add_node_to_current_heading(node) self._cur_doc =3D None =20 def _parse_text_into_node(self, doctext, node): --=20 2.45.0