| Message ID | 20250309083550.5155-49-jsnow@redhat.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | docs: Add new QAPI transmogrifier | expand |
John Snow <jsnow@redhat.com> writes: > 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. > > Signed-off-by: John Snow <jsnow@redhat.com> > --- > docs/sphinx/qapidoc.py | 9 +++++++++ > 1 file changed, 9 insertions(+) > > diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py > index b87ce288837..eaea19af7ac 100644 > --- a/docs/sphinx/qapidoc.py > +++ b/docs/sphinx/qapidoc.py > @@ -195,6 +195,15 @@ def visit_paragraph(self, section: QAPIDoc.Section) -> None: > 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? If I remember correctly, you wanted to mention this FIXME in the commit message. > + 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
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index b87ce288837..eaea19af7ac 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -195,6 +195,15 @@ def visit_paragraph(self, section: QAPIDoc.Section) -> None: 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
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. Signed-off-by: John Snow <jsnow@redhat.com> --- docs/sphinx/qapidoc.py | 9 +++++++++ 1 file changed, 9 insertions(+)