Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

translator: support for collapsible admonitions #1092

Merged
merged 1 commit into from
Feb 16, 2025
Merged

translator: support for collapsible admonitions #1092

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 33 additions & 5 deletions sphinxcontrib/confluencebuilder/storage/translator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -981,8 +981,10 @@ def depart_attribution(self, node):
# -----------

def _visit_admonition(self, node, atype, title=None, logo=True):
collapsible = node.get('collapsible', False)

self.body.append(self.start_ac_macro(node, atype))
if title:
if title and not collapsible:
self.body.append(self.build_ac_param(node, 'title', title))
if not logo:
self.body.append(
Expand All @@ -991,7 +993,20 @@ def _visit_admonition(self, node, atype, title=None, logo=True):
self.context.append(self.end_ac_rich_text_body_macro(node) +
self.end_ac_macro(node))

if collapsible:
self.body.append(self.start_ac_macro(node, 'expand'))
if title:
self.body.append(self.build_ac_param(node, 'title', title))
self.context.append(self.end_ac_macro(node))

self.body.append(self.start_ac_rich_text_body_macro(node))
self.context.append(self.end_ac_rich_text_body_macro(node))

def _depart_admonition(self, node):
if node.get('collapsible', False):
self.body.append(self.context.pop())
self.body.append(self.context.pop())

self.body.append(self.context.pop()) # macro (or blockquote)

def _visit_admonition_adf(self, node, atype, title=None, logo=True):
Expand Down Expand Up @@ -1042,24 +1057,37 @@ def _visit_warning(self, node):

def visit_admonition(self, node):
title_node = first(findall(node, nodes.title))
title = title_node.astext() if title_node else ''

if self.v2:
self._visit_admonition_adf(node, 'note')

if title_node:
title = title_node.astext()
collapsible = node.get('collapsible', False)
if collapsible:
self.body.append(self.start_ac_macro(node, 'expand'))
if title:
self.body.append(self.build_ac_param(node, 'title', title))
self.context.append(self.end_ac_macro(node))

self.body.append(self.start_ac_rich_text_body_macro(node))
self.context.append(self.end_ac_rich_text_body_macro(node))

if title and not collapsible:
self.body.append(self.start_tag(node, 'h3'))
self.body.append(title)
self.body.append(self.end_tag(node))
else:
if title_node:
title = title_node.astext()
if title:
self._visit_admonition(node, 'info', title, logo=False)
else:
self._visit_admonition(node, 'info', logo=False)

def depart_admonition(self, node):
if self.v2:
if node.get('collapsible', False):
self.body.append(self.context.pop())
self.body.append(self.context.pop())

self._depart_admonition_adf(node)
else:
self._depart_admonition(node)
Expand Down