Skip to content

Commit 4747c17

Browse files
committed
flag page-specific editor overrides as deprecated
Since Confluence Cloud is deprecating its legacy editor, we will start preparing for only using the `v2` editor on Confluence Cloud. To help start with the transition, flagging the page-specific editor override to warn users early of upcoming changes required. Signed-off-by: James Knight <git@jdknight.me>
1 parent 9be5196 commit 4747c17

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

sphinxcontrib/confluencebuilder/builder.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -954,6 +954,15 @@ def _extract_metadata(self, docname, doctree):
954954
else:
955955
metadata[k] = v
956956

957+
if k == 'editor':
958+
msg = 'page-specific editor overrides are deprecated'
959+
if node.source:
960+
lpf = f'#{node.line}' if node.line else ''
961+
self.warn(f'{msg}: {node.source}{lpf}',
962+
subtype='deprecated')
963+
else:
964+
self.warn(f'{msg}: {docname}', subtype='deprecated')
965+
957966
node.parent.remove(node)
958967

959968
def _find_title_element(self, doctree):

0 commit comments

Comments
 (0)