SYS-OSS/FRET-qemu
4
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs/qapidoc: remove example section support

Browse Source 
Since commit 3c5f6114 (qapi: remove "Example" doc section), Example
sections no longer exist, so this support in qapidoc is now dead code.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250224033741.222749-7-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
John Snow 2025-02-23 22:37:37 -05:00 committed by Markus Armbruster
parent b61a4eb3f3
commit 5e4c466e6a
1 changed files with 1 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/sphinx/qapidoc.py
View File

@ -254,10 +254,6 @@ class QAPISchemaGenRSTVisitor(QAPISchemaVisitor):
section += dlnode section += dlnode
return [section] return [section]
def _nodes_for_example(self, exampletext):
"""Return list of doctree nodes for a code example snippet"""
return [nodes.literal_block(exampletext, exampletext)]
def _nodes_for_sections(self, doc): def _nodes_for_sections(self, doc):
"""Return list of doctree nodes for additional sections""" """Return list of doctree nodes for additional sections"""
nodelist = [] nodelist = []
@ -275,10 +271,7 @@ class QAPISchemaGenRSTVisitor(QAPISchemaVisitor):
continue continue
snode = self._make_section(section.tag) snode = self._make_section(section.tag)
if section.tag.startswith('Example'): self._parse_text_into_node(dedent(section.text), snode)
snode += self._nodes_for_example(dedent(section.text))
else:
self._parse_text_into_node(dedent(section.text), snode)
nodelist.append(snode) nodelist.append(snode)
return nodelist return nodelist