From: Markus Armbruster <armbru@redhat.com>
To: John Snow <jsnow@redhat.com>
Cc: qemu-devel@nongnu.org, Peter Maydell <peter.maydell@linaro.org>,
Michael Roth <michael.roth@amd.com>
Subject: Re: [PATCH] docs/sphinx: fix extra stuff in TOC after freeform QMP sections
Date: Tue, 27 Aug 2024 11:40:01 +0200 [thread overview]
Message-ID: <87o75el2xa.fsf@pond.sub.org> (raw)
In-Reply-To: <20240822204803.1649762-1-jsnow@redhat.com> (John Snow's message of "Thu, 22 Aug 2024 16:48:03 -0400")
John Snow <jsnow@redhat.com> writes:
> 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 <armbru@redhat.com>
> Signed-off-by: John Snow <jsnow@redhat.com>
Tested-by: Markus Armbruster <armbru@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Queued, thanks!
prev parent reply other threads:[~2024-08-27 9:40 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-22 20:48 [PATCH] docs/sphinx: fix extra stuff in TOC after freeform QMP sections John Snow
2024-08-27 9:40 ` Markus Armbruster [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87o75el2xa.fsf@pond.sub.org \
--to=armbru@redhat.com \
--cc=jsnow@redhat.com \
--cc=michael.roth@amd.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.