diff options
| author | John Snow <jsnow@redhat.com> | 2021-04-06 10:19:09 -0400 |
|---|---|---|
| committer | Peter Maydell <peter.maydell@linaro.org> | 2021-04-13 10:14:58 +0100 |
| commit | 2d18b4ca023ca1a3aee18064251d6e6e1084f3eb (patch) | |
| tree | 9e6ca79efdff0776d237bc5a79bc772a7bc025dd /docs/sphinx | |
| parent | 91c0a79891b080efea276caf6bd3ff10809c4e4c (diff) | |
| download | focaccia-qemu-2d18b4ca023ca1a3aee18064251d6e6e1084f3eb.tar.gz focaccia-qemu-2d18b4ca023ca1a3aee18064251d6e6e1084f3eb.zip | |
sphinx: qapidoc: Wrap "If" section body in a paragraph node
These sections need to be wrapped in a block-level element, such as
Paragraph in order for them to be rendered into Texinfo correctly.
Before (e.g.):
<section ids="qapidoc-713">
<title>If</title>
<literal>defined(CONFIG_REPLICATION)</literal>
</section>
became:
.SS If
\fBdefined(CONFIG_REPLICATION)\fP.SS \fBBlockdevOptionsReplication\fP (Object)
...
After:
<section ids="qapidoc-713">
<title>If</title>
<paragraph>
<literal>defined(CONFIG_REPLICATION)</literal>
</paragraph>
</section>
becomes:
.SS If
.sp
\fBdefined(CONFIG_REPLICATION)\fP
.SS \fBBlockdevOptionsReplication\fP (Object)
...
Reported-by: Markus Armbruster <armbru@redhat.com>
Tested-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Message-id: 20210406141909.1992225-2-jsnow@redhat.com
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Diffstat (limited to 'docs/sphinx')
| -rw-r--r-- | docs/sphinx/qapidoc.py | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index b7b86b5dff..b7a2d39c10 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -278,7 +278,9 @@ class QAPISchemaGenRSTVisitor(QAPISchemaVisitor): nodelist = [] if ifcond: snode = self._make_section('If') - snode += self._nodes_for_ifcond(ifcond, with_if=False) + snode += nodes.paragraph( + '', '', *self._nodes_for_ifcond(ifcond, with_if=False) + ) nodelist.append(snode) return nodelist |