[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 16/23] docs/qapidoc: add visit_feature() method
From: |
John Snow |
Subject: |
[PATCH 16/23] docs/qapidoc: add visit_feature() method |
Date: |
Thu, 12 Dec 2024 21:18:19 -0500 |
The format_type() method is adjusted here to return None for features,
because Features don't have documented types. This makes
generate_field() safe to use for 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 7efe2d656c0..02f434c09ab 100644
--- a/docs/sphinx/qapidoc.py
+++ b/docs/sphinx/qapidoc.py
@@ -187,6 +187,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
--
2.47.0
- [PATCH 09/23] qapi/source: allow multi-line QAPISourceInfo advancing, (continued)
- [PATCH 09/23] qapi/source: allow multi-line QAPISourceInfo advancing, John Snow, 2024/12/12
- [PATCH 10/23] docs/qapidoc: add visit_freeform() method, John Snow, 2024/12/12
- [PATCH 11/23] docs/qapidoc: add preamble() method, John Snow, 2024/12/12
- [PATCH 12/23] docs/qapidoc: add visit_paragraph() method, John Snow, 2024/12/12
- [PATCH 14/23] docs/qapidoc: add format_type() method, John Snow, 2024/12/12
- [PATCH 15/23] docs/qapidoc: add add_field() and generate_field() helper methods, John Snow, 2024/12/12
- [PATCH 13/23] docs/qapidoc: add visit_errors() method, John Snow, 2024/12/12
- [PATCH 16/23] docs/qapidoc: add visit_feature() method,
John Snow <=
- [PATCH 19/23] docs/qapidoc: add visit_member() method, John Snow, 2024/12/12
- [PATCH 17/23] docs/qapidoc: record current documented entity in transmogrifier, John Snow, 2024/12/12
- [PATCH 21/23] docs/qapidoc: add visit_entity(), John Snow, 2024/12/12
- [PATCH 18/23] docs/qapidoc: add visit_returns() method, John Snow, 2024/12/12
- [PATCH 20/23] docs/qapidoc: add visit_sections() method, John Snow, 2024/12/12
- [PATCH 22/23] docs/qapidoc: implement transmogrify() method, John Snow, 2024/12/12
- [PATCH 23/23] docs/qapidoc: add transmogrifier test document, John Snow, 2024/12/12
- Re: [PATCH 00/23] docs: add basic sphinx-domain rST generator to qapidoc, Markus Armbruster, 2024/12/19