Merge pull request #1127 from sphinx-contrib/always-register-section-anchors

translator: register section anchors for all editors

Author: jdknight

sphinxcontrib/confluencebuilder/storage/translator.py

@@ -273,21 +273,22 @@ def visit_title(self, node):
             else:
                 docname = self.docname
 
-            # For v2, will will generate section anchors inside the title
-            # area for the following reasons:
+            # Generate section anchors inside the title area for the following
+            # reasons:
             # - We want to create inside the header inside if we input anchors
             #    before the header, it increase the space above the anchor
             #    due to how v2 styles a page.
             # - We are generating compatible anchor links (prefixed with the
             #    repsective document name) which helps allow `ac:link` macros
             #    properly link when coming from v1 or v2 editor pages.
-            if self.v2 and 'names' in node.parent:
+            # - Helps support anchor links for legacy editor on Confluence Cloud
+            if 'names' in node.parent:
                 for name in node.parent['names']:
                     anchor = name.replace(' ', '-')
                     target_name = f'{docname}/#{anchor}'
                     target = self.state.target(target_name)
                     if target and target not in new_targets:
-                        self._build_anchor(node, target)
+                        self._build_anchor(node, target, force_compat=True)
                         new_targets.append(target)
 
             # For MyST sections with an auto-generated slug, we will use this
@@ -3497,7 +3498,7 @@ def _build_id_anchors(self, node):
             for id_ in node['ids']:
                 self._build_anchor(node, id_)
 
-    def _build_anchor(self, node, anchor):
+    def _build_anchor(self, node, anchor, *, force_compat=False):
         """
         build an anchor on a page
 
@@ -3514,14 +3515,15 @@ def _build_anchor(self, node, anchor):
         Args:
             node: the node adding the anchor
             anchor: the name of the anchor to create
+            force_compat (optional): always force compat anchor
         """
 
         self.verbose(f'build anchor ({self.docname}): {anchor}')
         self.body.append(self.start_ac_macro(node, 'anchor'))
         self.body.append(self.build_ac_param(node, '', anchor))
         self.body.append(self.end_ac_macro(node, suffix=''))
 
-        if self.v2:
+        if self.builder.cloud or self.v2 or force_compat:
             doctitle = self.state.title(self.docname)
             doctitle = self.encode(doctitle.replace(' ', ''))
 

tests/unit-tests/test_rst_contents.py

@@ -60,7 +60,9 @@ def test_storage_rst_contents_backlinks_none(self):
             self.assertEqual(len(headers), 5)
 
             for header, expected in zip(headers, expected_header_text):
-                self.assertEqual(header.text, expected)
+                txt = ''.join(
+                    header.find_all(string=True, recursive=False)).strip()
+                self.assertEqual(txt, expected)
 
     @setup_builder('confluence')
     def test_storage_rst_contents_backlinks_top(self):

tests/unit-tests/test_rst_headings.py

@@ -6,6 +6,10 @@
 from tests.lib.testcase import setup_builder
 
 
+def strval(obj):
+    return ''.join(obj.find_all(string=True, recursive=False)).strip()
+
+
 class TestConfluenceRstHeadings(ConfluenceTestCase):
     @classmethod
     def setUpClass(cls):
@@ -23,21 +27,21 @@ def test_storage_rst_headings_default(self):
 
             header_lvl2 = data.find('h2')
             self.assertIsNotNone(header_lvl2)
-            self.assertEqual(header_lvl2.text, 'header 2')
+            self.assertEqual(strval(header_lvl2), 'header 2')
 
             header_lvl3 = data.find_all('h3')
             self.assertIsNotNone(header_lvl3)
             self.assertEqual(len(header_lvl3), 2)
-            self.assertEqual(header_lvl3[0].text, 'header 3')
-            self.assertEqual(header_lvl3[1].text, 'header 12')
+            self.assertEqual(strval(header_lvl3[0]), 'header 3')
+            self.assertEqual(strval(header_lvl3[1]), 'header 12')
 
             header_lvl4 = data.find('h4')
             self.assertIsNotNone(header_lvl4)
-            self.assertEqual(header_lvl4.text, 'header 4')
+            self.assertEqual(strval(header_lvl4), 'header 4')
 
             header_lvl5 = data.find('h5')
             self.assertIsNotNone(header_lvl5)
-            self.assertEqual(header_lvl5.text, 'header 5')
+            self.assertEqual(strval(header_lvl5), 'header 5')
 
             header_lvl6 = data.find_all('h6')
             self.assertIsNotNone(header_lvl6)
@@ -51,28 +55,29 @@ def test_storage_rst_headings_with_title(self):
         out_dir = self.build(self.dataset, config=config)
 
         with parse('index', out_dir) as data:
-            header_lvl1 = data.find('h1')
+            header_lvl1 = data.find('h1', recursive=False)
+            print(header_lvl1)
             self.assertIsNotNone(header_lvl1)
-            self.assertEqual(header_lvl1.text, 'header 1')
+            self.assertEqual(strval(header_lvl1), 'header 1')
 
-            header_lvl2 = data.find('h2')
+            header_lvl2 = data.find('h2', recursive=False)
             self.assertIsNotNone(header_lvl2)
-            self.assertEqual(header_lvl2.text, 'header 2')
+            self.assertEqual(strval(header_lvl2), 'header 2')
 
-            header_lvl3 = data.find_all('h3')
+            header_lvl3 = data.find_all('h3', recursive=False)
             self.assertIsNotNone(header_lvl3)
             self.assertEqual(len(header_lvl3), 2)
-            self.assertEqual(header_lvl3[0].text, 'header 3')
-            self.assertEqual(header_lvl3[1].text, 'header 12')
+            self.assertEqual(strval(header_lvl3[0]), 'header 3')
+            self.assertEqual(strval(header_lvl3[1]), 'header 12')
 
-            header_lvl4 = data.find('h4')
+            header_lvl4 = data.find('h4', recursive=False)
             self.assertIsNotNone(header_lvl4)
-            self.assertEqual(header_lvl4.text, 'header 4')
+            self.assertEqual(strval(header_lvl4), 'header 4')
 
-            header_lvl5 = data.find('h5')
+            header_lvl5 = data.find('h5', recursive=False)
             self.assertIsNotNone(header_lvl5)
-            self.assertEqual(header_lvl5.text, 'header 5')
+            self.assertEqual(strval(header_lvl5), 'header 5')
 
-            header_lvl6 = data.find_all('h6')
+            header_lvl6 = data.find_all('h6', recursive=False)
             self.assertIsNotNone(header_lvl6)
             self.assertEqual(len(header_lvl6), 6)

tests/unit-tests/test_rst_references.py

@@ -65,13 +65,8 @@ def test_storage_rst_references(self):
 
             # anchors ##################################################
 
-            anchors = data.find_all('ac:structured-macro',
+            anchor = data.find('ac:structured-macro',
                 {'ac:name': 'anchor'})
-            self.assertEqual(len(anchors), 1)
-
-            # (anchor 1)
-            anchor = anchors.pop(0)
-
             anchor_id = anchor.find('ac:parameter')
             self.assertIsNotNone(anchor_id)
             self.assertEqual(anchor_id.text, 'my-reference-label1')

tests/unit-tests/test_singlepage_toctree.py

@@ -14,6 +14,12 @@ def test_storage_singlepage_toctree_default(self):
         out_dir = self.build(dataset)
 
         with parse('index', out_dir) as data:
+            # ignore any anchor tags for these checks
+            for tag in data.find_all(
+                    'ac:structured-macro', attrs={'ac:name': 'anchor'}):
+                print(tag)
+                tag.decompose()
+
             tags = data.find_all()
             self.assertIsNotNone(tags)
             self.assertEqual(len(tags), 12)
@@ -76,6 +82,12 @@ def test_storage_singlepage_toctree_numbered(self):
         out_dir = self.build(dataset)
 
         with parse('index', out_dir) as data:
+            # ignore any anchor tags for these checks
+            for tag in data.find_all(
+                    'ac:structured-macro', attrs={'ac:name': 'anchor'}):
+                print(tag)
+                tag.decompose()
+
             tags = data.find_all()
             self.assertIsNotNone(tags)
             self.assertEqual(len(tags), 6)