diff options
| author | John Snow <jsnow@redhat.com> | 2025-03-10 23:42:42 -0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2025-03-11 10:10:57 +0100 |
| commit | 56e1adf293037ec3324a7f20d54d50cd671dc281 (patch) | |
| tree | 9382b03f6847aa4b0e15a27e4ee418696ac5ac8d /docs | |
| parent | 803df114fd68b5e7a3d6c60b162c0013cf6966e6 (diff) | |
| download | qemu-56e1adf293037ec3324a7f20d54d50cd671dc281.zip qemu-56e1adf293037ec3324a7f20d54d50cd671dc281.tar.gz qemu-56e1adf293037ec3324a7f20d54d50cd671dc281.tar.bz2 | |
docs/qapidoc: add visit_paragraph() method
This transforms "formerly known as untagged sections" into our pure
intermediate rST format. These sections are already pure rST, so this
method doesn't do a whole lot except ensure appropriate newlines.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250311034303.75779-45-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sphinx/qapidoc.py | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index f56aa6d..a9f98d4 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -130,6 +130,15 @@ class Transmogrifier: # Transmogrification helpers + def visit_paragraph(self, section: QAPIDoc.Section) -> None: + # Squelch empty paragraphs. + if not section.text: + return + + self.ensure_blank_line() + self.add_lines(section.text, section.info) + self.ensure_blank_line() + def preamble(self, ent: QAPISchemaDefinition) -> None: """ Generate option lines for QAPI entity directives. |