[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 17/23] docs/qapidoc: record current documented entity in transmog
From: |
John Snow |
Subject: |
[PATCH 17/23] docs/qapidoc: record current documented entity in transmogrifier |
Date: |
Thu, 12 Dec 2024 21:18:20 -0500 |
Keep a record of which entity we're working on documenting for the
purposes of being able to change certain generative features
conditionally and create stronger assertions.
If you find yourself asking: "Wait, but where does the current entity
actually get recorded?!", you're right! That part comes with the
visit_entity() implementation, which gets added later.
Signed-off-by: John Snow <jsnow@redhat.com>
---
docs/sphinx/qapidoc.py | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py
index 02f434c09ab..c731c597daf 100644
--- a/docs/sphinx/qapidoc.py
+++ b/docs/sphinx/qapidoc.py
@@ -74,9 +74,15 @@ def dedent(text: str) -> str:
class Transmogrifier:
def __init__(self, schema):
+ self._curr_ent = None
self._result = StringList()
self.indent = 0
+ @property
+ def entity(self) -> QAPISchemaEntity:
+ assert self._curr_ent is not None
+ return self._curr_ent
+
# General-purpose rST generation functions
def get_indent(self) -> str:
--
2.47.0
- Re: [PATCH 10/23] docs/qapidoc: add visit_freeform() 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 <=
- [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