Re: [PATCH] docs/sphinx: fix extra stuff in TOC after freeform QMP sections

[Markus Armbruster]

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!