| Message ID | 20241213021827.2956769-4-jsnow@redhat.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | docs: add basic sphinx-domain rST generator to qapidoc | expand |
John Snow <jsnow@redhat.com> writes: > Since 3c5f6114 we no longer actually generate Example sections, so this Suggest s/generate/support/ > support in qapidoc is now dead code. Oversight, I guess. > > Signed-off-by: John Snow <jsnow@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com>
On Wed, Dec 18, 2024, 7:27 AM Markus Armbruster <armbru@redhat.com> wrote: > John Snow <jsnow@redhat.com> writes: > > > Since 3c5f6114 we no longer actually generate Example sections, so this > > Suggest s/generate/support/ > I meant to say: because the parser doesn't support them, it no longer creates such section objects, so there's no need to handle them. > > support in qapidoc is now dead code. > > Oversight, I guess. > O:-) > > > > Signed-off-by: John Snow <jsnow@redhat.com> > > Reviewed-by: Markus Armbruster <armbru@redhat.com> > >
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index 5a4d7388b29..61997fd21af 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -254,10 +254,6 @@ def _nodes_for_features(self, doc): section += dlnode 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): """Return list of doctree nodes for additional sections""" nodelist = [] @@ -275,10 +271,7 @@ def _nodes_for_sections(self, doc): continue snode = self._make_section(section.tag) - if section.tag.startswith('Example'): - snode += self._nodes_for_example(dedent(section.text)) - else: - self._parse_text_into_node(dedent(section.text), snode) + self._parse_text_into_node(dedent(section.text), snode) nodelist.append(snode) return nodelist
Since 3c5f6114 we no longer actually generate Example sections, so this support in qapidoc is now dead code. Signed-off-by: John Snow <jsnow@redhat.com> --- docs/sphinx/qapidoc.py | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-)