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 71AA3C27C53 for ; Wed, 19 Jun 2024 12:06:26 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sJu4r-0006F0-S3; Wed, 19 Jun 2024 08:06: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 1sJu4o-0006DS-64 for qemu-devel@nongnu.org; Wed, 19 Jun 2024 08:06:10 -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 1sJu4m-0000iR-Bu for qemu-devel@nongnu.org; Wed, 19 Jun 2024 08:06:09 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1718798767; 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=CXS7exdmHsNSzIiXyXEIQ7mcyq+uxgwr63z/xdTM2ZE=; b=cSM6SLkqe5VirKimQAk4gVHYo7B7y/Xx7dF2S2/TVxndJ3JWrcNgtMrklnpzqOYQ1y5/iB TvBzkF7/yHGKsiJ+u+82/E8c8EgtZkWZa+Tn3iL2lQ9HIKVZE8G9HixszO5RlNiE0c5gnL 3CeO6MYmeen4LKnGOl7w4cccWVjSsSI= 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-678-A1khnYWMPRuCo6gf5PfgSA-1; Wed, 19 Jun 2024 08:06:02 -0400 X-MC-Unique: A1khnYWMPRuCo6gf5PfgSA-1 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-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 6B4FE19560B5; Wed, 19 Jun 2024 12:06:00 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.93]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 6E4AE1956052; Wed, 19 Jun 2024 12:05:59 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 10E7421E6687; Wed, 19 Jun 2024 14:05:56 +0200 (CEST) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, Stefan Hajnoczi , Hanna Reitz , Michael Roth , Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= , Victor Toso de Carvalho , "Michael S. Tsirkin" , Konstantin Kostiuk , Yanan Wang , Pavel Dovgalyuk , =?utf-8?Q?Marc-Andr=C3=A9?= Lureau , Marcel Apfelbaum , Fabiano Rosas , Lukas Straub , Eduardo Habkost , Mads Ynddal , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , Gerd Hoffmann , Stefan Berger , Peter Xu , Igor Mammedov , =?utf-8?Q?C=C3=A9dric?= Le Goater , Jason Wang , Ani Sinha , Paolo Bonzini , Peter Maydell , qemu-block@nongnu.org, Jiri Pirko , Alex Williamson , Kevin Wolf , Eric Blake Subject: Re: [PATCH 06/13] docs/qapidoc: fix nested parsing under untagged sections In-Reply-To: <20240619003012.1753577-7-jsnow@redhat.com> (John Snow's message of "Tue, 18 Jun 2024 20:30:05 -0400") References: <20240619003012.1753577-1-jsnow@redhat.com> <20240619003012.1753577-7-jsnow@redhat.com> Date: Wed, 19 Jun 2024 14:05:56 +0200 Message-ID: <87y17116jf.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.17 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: 11 X-Spam_score: 1.1 X-Spam_bar: + X-Spam_report: (1.1 / 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_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, T_SCC_BODY_TEXT_LINE=-0.01 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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org John Snow writes: > Sphinx does not like sections without titles, because it wants to > convert every section into a reference. When there is no title, it > struggles to do this and transforms the tree inproperly. > > Depending on the rST used, this may result in an assertion error deep in > the docutils HTMLWriter. > > (Observed when using ".. admonition:: Notes" under such a section - When > this is transformed with its own element, Sphinx is fooled into > believing this title belongs to the section and incorrect mutates the > docutils tree, leading to errors during rendering time.) > > When parsing an untagged section (free paragraphs), skip making a hollow > section and instead append the parse results to the prior section. > > Many Bothans died to bring us this information. > > Signed-off-by: John Snow <jsnow@redhat.com> > --- > docs/sphinx/qapidoc.py | 16 +++++++++++----- > 1 file changed, 11 insertions(+), 5 deletions(-) > > diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py > index f2f2005dd5f..66cf254a624 100644 > --- a/docs/sphinx/qapidoc.py > +++ b/docs/sphinx/qapidoc.py > @@ -286,14 +286,20 @@ def _nodes_for_sections(self, doc): > if section.tag and section.tag == 'TODO': > # Hide TODO: sections > continue > + > + if not section.tag: > + # Sphinx cannot handle sectionless titles; > + # Instead, just append the results to the prior section. > + container = nodes.container() > + self._parse_text_into_node(section.text, container) > + nodelist += container.children > + continue > + > snode = self._make_section(section.tag) > - if section.tag and section.tag.startswith('Example'): > + if section.tag.startswith('Example'): > snode += self._nodes_for_example(dedent(section.text)) > else: > - self._parse_text_into_node( > - dedent(section.text) if section.tag else section.text, > - snode, > - ) > + self._parse_text_into_node(dedent(section.text), snode) > nodelist.append(snode) > return nodelist Acked-by: Markus Armbruster <armbru@redhat.com>