diff options
| author | John Snow <jsnow@redhat.com> | 2025-03-10 23:42:46 -0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2025-03-11 10:10:57 +0100 |
| commit | 6c43b008c4b6338f49b6dffb82437285bf98b97a (patch) | |
| tree | 242a9d1f60b32e7eef583bec3e456b6c971434d9 /docs | |
| parent | 604df9bb001fc66f77d349ce63e870af84b42d96 (diff) | |
| download | qemu-6c43b008c4b6338f49b6dffb82437285bf98b97a.zip qemu-6c43b008c4b6338f49b6dffb82437285bf98b97a.tar.gz qemu-6c43b008c4b6338f49b6dffb82437285bf98b97a.tar.bz2 | |
docs/qapidoc: add visit_feature() method
This adds a simple ":feat name: lorem ipsum ..." line to the generated
rST document, so at the moment it's only for "top level" features.
Features not attached directly to a QAPI definition are not currently
handled! This is a small regression over the prior documentation
generator that will be addressed in a future patch.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250311034303.75779-49-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 2f85fe0..208d7ca 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -195,6 +195,15 @@ class Transmogrifier: self.add_lines(section.text, section.info) self.ensure_blank_line() + def visit_feature(self, section: QAPIDoc.ArgSection) -> None: + # FIXME - ifcond for features is not handled at all yet! + # Proposal: decorate the right-hand column with some graphical + # element to indicate conditional availability? + assert section.text # Guaranteed by parser.py + assert section.member + + self.generate_field("feat", section.member, section.text, section.info) + def visit_errors(self, section: QAPIDoc.Section) -> None: # FIXME: the formatting for errors may be inconsistent and may # or may not require different newline placement to ensure |