Fix skipping with identical code to linked blocks (#172)

Author: felix-hilden

docs/src/release_notes.rst

@@ -19,6 +19,7 @@ sphinx-codeautolink adheres to
   and ``highlight_language`` configuration (:issue:`166`)
 - Add :confval:`codeautolink_warn_on_default_parse_fail` to warn about
   failing to link code blocks without a language parameter (:issue:`166`)
+- Fix skipping blocks with identical content to linked ones (:issue:`172`)
 
 0.16.2 (2025-01-16)
 -------------------

src/sphinx_codeautolink/extension/block.py

@@ -196,7 +196,7 @@ def visit_literal_block(self, node: nodes.literal_block):
         """Visit a generic literal block."""
         return self.parse_source(node, node.get("language", self.highlight_lang))
 
-    def parse_source(
+    def parse_source(  # noqa: C901
         self, node: nodes.literal_block | nodes.doctest_block, language: str | None
     ) -> None:
         """Analyse Python code blocks."""
@@ -208,14 +208,22 @@ def parse_source(
             self.skip = None
 
         if (
-            skip
-            or len(node.children) != 1
+            len(node.children) != 1
             or not isinstance(node.children[0], nodes.Text)
             or language not in self.valid_blocks
         ):
             return
 
         source = node.children[0].astext()
+        example = CodeExample(
+            self.current_document, self.current_refid, list(self.title_stack)
+        )
+        transform = SourceTransform(source, [], example, node.line)
+        self.source_transforms.append(transform)
+
+        if skip:
+            return
+
         transformer = self.transformers[language]
         if transformer:
             try:
@@ -228,11 +236,7 @@ def parse_source(
                 return
         else:
             clean_source = source
-        example = CodeExample(
-            self.current_document, self.current_refid, list(self.title_stack)
-        )
-        transform = SourceTransform(source, [], example, node.line)
-        self.source_transforms.append(transform)
+        transform.source = source
 
         modified_source = "\n".join(
             self.global_preface + self.concat_sources + prefaces + [clean_source]
@@ -244,7 +248,7 @@ def parse_source(
                 return
 
             show_source = self._format_source_for_error(
-                self.global_preface, self.concat_sources, prefaces, source
+                self.global_preface, self.concat_sources, prefaces, transform.source
             )
             msg = self._parsing_error_msg(e, language, show_source)
             logger.warning(msg, type=warn_type, subtype="parse_block", location=node)

tests/extension/__init__.py

@@ -280,6 +280,37 @@ def test_parallel_build(tmp_path: Path):
     assert check_link_targets(result_dir) == n_subfiles * len(links)
 
 
+def test_skip_identical_code(tmp_path: Path):
+    """Code skipped and then linked in an identical block after."""
+    index = """
+Test project
+============
+
+.. autolink-skip::
+.. code:: python
+
+   import test_project
+   test_project.bar()
+
+.. code:: python
+
+   import test_project
+   test_project.bar()
+
+.. automodule:: test_project
+"""
+    files = {"conf.py": default_conf, "index.rst": index}
+    result_dir = _sphinx_build(tmp_path, "html", files)
+
+    index_html = result_dir / "index.html"
+    text = index_html.read_text("utf-8")
+    soup = BeautifulSoup(text, "html.parser")
+    blocks = list(soup.select(".highlight-python"))
+    assert len(blocks) == 2
+    assert "sphinx-codeautolink-a" not in str(blocks[0])
+    assert "sphinx-codeautolink-a" in str(blocks[1])
+
+
 def _sphinx_build(
     folder: Path, builder: str, files: dict[str, str], n_processes: int | None = None
 ) -> Path:

tests/extension/ref/skip_next_consumed_non_python.txt

@@ -6,7 +6,7 @@ Test project
 ============
 
 .. autolink-skip::
-.. code::
+.. code:: c
 
    import test_project
    test_project.bar()