diff options
| author | John Snow <jsnow@redhat.com> | 2025-03-10 23:42:47 -0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2025-03-11 10:10:57 +0100 |
| commit | 38a349ff5b9ae583fe8a66e3e507ea9954b1aeb1 (patch) | |
| tree | e2e0b04c42d2af687a78e6081fbdfed75947e117 | |
| parent | 6c43b008c4b6338f49b6dffb82437285bf98b97a (diff) | |
| download | focaccia-qemu-38a349ff5b9ae583fe8a66e3e507ea9954b1aeb1.tar.gz focaccia-qemu-38a349ff5b9ae583fe8a66e3e507ea9954b1aeb1.zip | |
docs/qapidoc: prepare to record entity being transmogrified
Prepare to 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. This patch is front-loaded for the sake of type checking in the forthcoming commits before visit_entity() is ready to be added. Signed-off-by: John Snow <jsnow@redhat.com> Message-ID: <20250311034303.75779-50-jsnow@redhat.com> Acked-by: Markus Armbruster <armbru@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| -rw-r--r-- | docs/sphinx/qapidoc.py | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index 208d7ca144..47c2eeef87 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -78,9 +78,15 @@ __version__ = "1.0" class Transmogrifier: def __init__(self) -> None: + self._curr_ent: Optional[QAPISchemaDefinition] = None self._result = StringList() self.indent = 0 + @property + def entity(self) -> QAPISchemaDefinition: + assert self._curr_ent is not None + return self._curr_ent + # General-purpose rST generation functions def get_indent(self) -> str: |