[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 20/23] docs/qapidoc: add visit_sections() method
From: |
John Snow |
Subject: |
[PATCH 20/23] docs/qapidoc: add visit_sections() method |
Date: |
Thu, 12 Dec 2024 21:18:23 -0500 |
Implement the actual main dispatch method that processes and handles the
list of doc sections for a given QAPI entity.
Signed-off-by: John Snow <jsnow@redhat.com>
---
docs/sphinx/qapidoc.py | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py
index fe01ee71c26..eda6aa0897b 100644
--- a/docs/sphinx/qapidoc.py
+++ b/docs/sphinx/qapidoc.py
@@ -278,6 +278,29 @@ def preamble(self, ent: QAPISchemaEntity) -> None:
self.ensure_blank_line()
+ def visit_sections(self, ent: QAPISchemaEntity) -> None:
+ sections = ent.doc.all_sections if ent.doc else []
+
+ # Add sections *in the order they are documented*:
+ for section in sections:
+ if section.tag == QAPIDoc.Tag.UNTAGGED:
+ self.visit_paragraph(section)
+ elif section.tag == QAPIDoc.Tag.MEMBER:
+ self.visit_member(section)
+ elif section.tag == QAPIDoc.Tag.FEATURE:
+ self.visit_feature(section)
+ elif section.tag in (QAPIDoc.Tag.SINCE, QAPIDoc.Tag.TODO):
+ # Since is handled in preamble, TODO is skipped intentionally.
+ pass
+ elif section.tag == QAPIDoc.Tag.RETURNS:
+ self.visit_returns(section)
+ elif section.tag == QAPIDoc.Tag.ERRORS:
+ self.visit_errors(section)
+ else:
+ assert False
+
+ self.ensure_blank_line()
+
# Transmogrification core methods
def visit_module(self, path: str) -> None:
--
2.47.0
- [PATCH 11/23] docs/qapidoc: add preamble() method, (continued)
- [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, 2024/12/12
- [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 <=
- [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